Document Status Resource¶
Get Document Status¶
HTTP Request
GET /api/documentStatus/{id}
📋 Description: Retrieves the status of a specific document identified by its unique ID, providing essential insights into its current state within the business workflow.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "documentStatusType": "string",
10 "isDefaultType": true
11}
Update Document Status¶
HTTP Request
PUT /api/documentStatus/{id}
📋 Description: Updates the status of a specified document by its unique identifier, enabling users to manage document workflows effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated document status information, including relevant metadata and approval details for the specified document ID. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "documentStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Document Status¶
HTTP Request
DELETE /api/documentStatus/{id}
📋 Description: Deletes the document status identified by the specified ID, ensuring the removal of outdated or unnecessary records from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Document Status¶
HTTP Request
GET /api/documentStatus
📋 Description: Retrieves the current status of documents within the system, providing insights into their processing stages and facilitating effective document management.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "isDefault": true,
9 "objectAvailable": true,
10 "documentStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the status of a document within the workflow, including relevant metadata to facilitate tracking and management of document progress in business processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the document is currently available for processing or review within the system. |
» documentStatusType |
string |
false |
none |
Type of the document status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Document Status¶
HTTP Request
POST /api/documentStatus
📋 Description: Submits a request to update the status of a document, facilitating efficient document management and workflow processes within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the document status update details, including the document ID, current status, and any relevant metadata for tracking purposes. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "documentStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Document Status Type¶
HTTP Request
GET /api/documentStatus/documentStatusType
📋 Description: Retrieves the available document status types, providing essential information for managing document workflows and ensuring compliance within business processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "VALID"
3]
Response Schema
Get All Active Asset Category Type IDs¶
HTTP Request
GET /api/documentStatus/allActiveDocumentStatusTypes
📋 Description: Retrieves all active document status types, providing essential insights into the current state of documents within the system for effective management and tracking.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]