Interpretation of Project Document Management API Responses
This topic explains how you can interpret the responses from the Project Document Management API.
{
id string
name string
size integer
version string
parentFolderId string
projectId string
owner string
lastModifiedDate string
creationDate string
documentType string
active string
status string
otherVersion [...]
childrenDocument [...]
}
|
Field |
Description |
|---|---|
|
id |
Contains the ID of the document, folder, project, or workspace. |
|
name |
Contains the name of document, folder, project, or workspace. |
|
size |
Indicates the size of the file in bytes. |
|
version |
Indicates the version of the file. |
|
parentFolderId |
Contains the ID of the parent folder. |
|
projectId |
Contains the ID of the sourcing project or workspace. |
|
owner |
Contains the user name of the document owner. |
|
lastModifiedDate |
Contains the last modified date of the document or folder. |
|
creationDate |
Contains the date the document or folder was created. |
|
documentType |
Indicates the type of the document. |
|
active |
Indicates whether the document is active or not. |
|
status |
Contains the status of the document. |
|
otherVersion |
Indicates whether the document has other versions, and if yes, provides details of that. |
|
childrenDocument |
Contains details of the child documents. |
You can use a combination these fields to understand the folder structure and relationship between various elements and documents.
The following sections provide some example outputs to help you understand different responses in various use cases.
For a Header-Level Document
{
"id": "Doc12739754",
"name": "Document.docx",
"size": 16049,
"version": "1",
"parentFolderId": "CW27570",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T08:54:56.882+0000",
"creationDate": "2020-04-24T08:54:56.882+0000",
"documentType": "Document",
"active": true,
"status": "Draft",
"otherVersion": []
}
For a Document That Is Within a Folder
{
"id": "WS12739767",
"name": "Document Inside A Folder",
"version": "1",
"parentFolderId": "CW27570",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T08:59:09.843+0000",
"creationDate": "2020-04-24T08:57:36.966+0000",
"documentType": "Folder",
"active": true,
"childrenDocument": [
{
"id": "Doc12739788",
"name": "Document.docx",
"size": 16049,
"version": "1",
"parentFolderId": "WS12739767",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T08:59:09.843+0000",
"creationDate": "2020-04-24T08:59:09.843+0000",
"documentType": "Document",
"active": true,
"status": "Draft",
"otherVersion": []
}
]
}
For a Document Within a Subfolder
{
"id": "WS12739814",
"name": "Parent Folder",
"version": "1",
"parentFolderId": "CW27570",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:04:51.904+0000",
"creationDate": "2020-04-24T09:03:31.754+0000",
"documentType": "Folder",
"active": true,
"childrenDocument": [
{
"id": "WS12739824",
"name": "Child Folder 1",
"version": "1",
"parentFolderId": "WS12739814",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:05:03.534+0000",
"creationDate": "2020-04-24T09:04:40.772+0000",
"documentType": "Folder",
"active": true,
"childrenDocument": [
{
"id": "Doc12739825",
"name": "Document.docx",
"size": 16049,
"version": "1",
"parentFolderId": "WS12739824",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:05:03.534+0000",
"creationDate": "2020-04-24T09:05:03.534+0000",
"documentType": "Document",
"active": true,
"status": "Draft",
"otherVersion": []
}
]
}
]
}
For a Document in a Subfolder of a Subfolder
{
"id": "WS12740572",
"name": "Parent Folder",
"version": "1",
"parentFolderId": "CW27570",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:14:28.354+0000",
"creationDate": "2020-04-24T09:13:45.146+0000",
"documentType": "Folder",
"active": true,
"childrenDocument": [
{
"id": "WS12740576",
"name": "Level 1",
"version": "2",
"parentFolderId": "WS12740572",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:15:08.073+0000",
"creationDate": "2020-04-24T09:14:16.520+0000",
"documentType": "Folder",
"active": true,
"childrenDocument": [
{
"id": "WS12740580",
"name": "Sub Level 1",
"version": "1",
"parentFolderId": "WS12740576",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:15:32.343+0000",
"creationDate": "2020-04-24T09:14:58.883+0000",
"documentType": "Folder",
"active": true,
"childrenDocument": [
{
"id": "WS12740582",
"name": "Sub Level 2",
"version": "1",
"parentFolderId": "WS12740580",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:15:44.962+0000",
"creationDate": "2020-04-24T09:15:20.426+0000",
"documentType": "Folder",
"active": true,
"childrenDocument": [
{
"id": "Doc12740583",
"name": "MainAgreement.docx",
"size": 59206,
"version": "1",
"parentFolderId": "WS12740582",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:15:44.963+0000",
"creationDate": "2020-04-24T09:15:44.963+0000",
"documentType": "Main Agreement",
"active": true,
"status": "Draft",
"otherVersion": []
}
]
}
]
}
]
}
]
}
For a Document That Has a Task Attached to It
{
"id": "Doc12740556",
"name": "OpenAPI Contract Addendum.docx",
"size": 15257,
"version": "1",
"parentFolderId": "CW27570",
"projectId": "CW27570",
"owner": "customersupportadmin",
"lastModifiedDate": "2020-04-24T09:07:30.697+0000",
"creationDate": "2020-04-24T09:07:30.697+0000",
"documentType": "Document",
"active": true,
"status": "Draft",
"otherVersion": []
}