DocumentDTO¶
Example Json Object
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}
📄 Description: Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
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 |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
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 reference to the associated document, facilitating easy access and retrieval within the system. |
parentEntityName |
string |
true |
none |
Name of the parent entity |