Document¶
Get Document By ID¶
HTTP Request
GET /api/documents/{documentId}
📋 Description: Retrieves the specified document by its unique identifier, providing essential details for review and management within the document management system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "contentType": "string",
7 "documentTypeName": "string",
8 "documentTypeId": 0,
9 "description": "string",
10 "data": "string",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "documentStatusId": 0,
14 "documentStatus": "string",
15 "documentStatusType": "string",
16 "parentEntityId": 0,
17 "link": "string",
18 "parentEntityName": "string"
19}
Delete Document¶
HTTP Request
DELETE /api/documents/{documentId}
📋 Description: Deletes a specified document from the system, ensuring that sensitive information is securely removed and compliance with data retention policies is maintained.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Create Document¶
HTTP Request
POST /api/documents
📋 Description: Creates a new document within the system, enabling users to efficiently manage and store essential business information.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
Request body containing the document details including title, content, and associated metadata for processing and storage. |
» document |
body |
true |
Data transfer object representing a document within the system, encapsulating essential details such as title, content, and associated metadata to facilitate efficient document management and retrieval. |
|
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»» name |
body |
string |
false |
Name of the resource |
»» contentType |
body |
string |
false |
Type of the content |
»» documentTypeName |
body |
string |
false |
Name of the document type |
»» documentTypeId |
body |
integer(int64) |
false |
Unique identifier for the document type |
»» description |
body |
string |
false |
Description of the resource |
»» data |
body |
string(byte) |
false |
Represents the content of the document, encapsulating essential information for processing and retrieval within the system. |
»» startDate |
body |
string(date) |
false |
Start date of the resource |
»» endDate |
body |
string(date) |
false |
End date of the resource |
»» documentStatusId |
body |
integer(int64) |
false |
Unique identifier for the document status |
»» documentStatus |
body |
string |
false |
Status of the document |
»» documentStatusType |
body |
string |
false |
Type of the document status |
»» parentEntityId |
body |
integer(int64) |
true |
Unique identifier for the parent entity |
»» link |
body |
string |
false |
URL link to access the associated document within the system. |
»» parentEntityName |
body |
string |
true |
Name of the parent entity |
» file |
body |
string(binary) |
true |
none |
Body Parameters
1{
2 "document": {
3 "contentType": "string",
4 "createdAt": "2019-08-24 14:15:22+00:00",
5 "createdBy": "string",
6 "data": "string",
7 "description": "string",
8 "documentStatus": "string",
9 "documentStatusId": 0,
10 "documentStatusType": "string",
11 "documentTypeId": 0,
12 "documentTypeName": "string",
13 "endDate": "2019-08-24",
14 "id": 0,
15 "link": "string",
16 "name": "string",
17 "parentEntityId": 0,
18 "parentEntityName": "string",
19 "startDate": "2019-08-24"
20 },
21 "file": "string"
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Get Documents By Entity¶
HTTP Request
GET /api/documents/{entity}/{entityId}
📋 Description: Fetches detailed information about a specific document associated with the given entity and entity ID, enabling users to access critical data for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity |
path |
string |
true |
Specifies the type of entity, such as ‘document’ or ‘user’, to retrieve the associated resource identified by the entityId. |
entityId |
path |
integer(int64) |
true |
Unique identifier for the entity |
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 "name": "string",
7 "contentType": "string",
8 "documentTypeName": "string",
9 "documentTypeId": 0,
10 "description": "string",
11 "data": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "documentStatusId": 0,
15 "documentStatus": "string",
16 "documentStatusType": "string",
17 "parentEntityId": 0,
18 "link": "string",
19 "parentEntityName": "string"
20 }
21]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a document within the system, encapsulating essential details such as title, content, and associated metadata to facilitate efficient document management and retrieval.] |
|
» 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 |
» name |
string |
false |
none |
Name of the resource |
» contentType |
string |
false |
none |
Type of the content |
» documentTypeName |
string |
false |
none |
Name of the document type |
» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
» description |
string |
false |
none |
Description of the resource |
» data |
string(byte) |
false |
none |
Represents the content of the document, encapsulating essential information for processing and retrieval within the system. |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
» documentStatus |
string |
false |
none |
Status of the document |
» documentStatusType |
string |
false |
none |
Type of the document status |
» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
» link |
string |
false |
none |
URL link to access the associated document within the system. |
» parentEntityName |
string |
true |
none |
Name of the parent entity |
Download Document¶
HTTP Request
GET /api/documents/download/{documentId}
📋 Description: Downloads the specified document identified by the documentId, enabling users to access important files for review or distribution within their business processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Get All Document Types¶
HTTP Request
GET /api/documents/document-types
📋 Description: Retrieves a list of available document types, providing essential information for users to categorize and manage documents effectively within the system.
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 "objectAvailable": true
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a classification of documents within the system, encapsulating essential attributes and metadata to facilitate efficient document management and retrieval.] |
|
» 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 |
» objectAvailable |
boolean |
false |
none |
Indicates whether the document type is currently available for use within the system. |