Retrieve a Document Group
Retrieve a Document Group
Path Parameters
- project_id integer required
ID of the project that contains the group
- group_id integer required
ID of the group to get
Responses
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- created date-time
- document_count integer
Total of documents
- id integer
The ID of the document group.
- name string
The document group's name.
- project_id integer
The ID of the project that the document group belongs to.
- source string
Possible values: [
ANALYSIS
,UPLOAD
,ANNOTATIONS
]The source of the documents for that group
- status string
Possible values: [
PROCESSING
,CREATED
,DELETING
,FAILED
]The document group's status.
{
"created": "2023-11-02",
"document_count": 100,
"id": 18,
"name": "This is my first group",
"project_id": 0,
"source": "ANALYSIS",
"status": "PROCESSING"
}
User is not authenticated. This means token is either not present or invalid
User does not have the minimal required project role "VIEWER"
The group or the project was not found
Something is wrong with the API.
Loading...