Files
See the list of all available HTTP methods for this resource at end of this page.
Resource Representation
{
"canonicalPath": [
{
"id": "ccf4c1b7-4f36-4282-8beb-b66823285797",
"name": "My Folder"
}
],
"created": "2019-12-15T23:45:32.000Z",
"createdBy": {
"id": "4975a794-26b0-47a9-b953-a57bb2dc5719",
"name": "foo"
},
"folderId": "c7385b2e-14ac-42b5-98fc-3c960201134c",
"id": "def751d7-eccd-4f94-952e-f62988cef786",
"name": "My First File",
"projectId": "6e1b3175-3b6c-4fc4-9af5-36081d6428c0",
"revision": 1,
"type": "BPMN",
"simplePath": "My Folder/My First File.bpmn",
"updated": "2020-12-15T23:45:32.000Z",
"updatedBy": {
"id": "c8bc0a6a-13bb-49ad-9fcd-60a9a0c4b411",
"name": "bar"
}
}
| Name | Type | Description |
|---|---|---|
| canonicalPath | object[] | Contains the unique path of the file within the project. It is an array of objects representing folders which contain the id and the name of each path element. |
| created | date (in ISO-8601 format) | Creation date and time of the file. |
| createdBy.id | string | Unique identifier of the user who created the file. |
| createdBy.name | string | Name of the user who created the file. |
| folderId (optional) | string | Unique identifier of the parent folder the file is located in. |
| id | string | Unique identifier of the file. |
| name | string | Name of the file. |
| projectId | string | Unique identifier of the project the file is located in. |
| simplePath | string | Contains the human-readable path of the file within the project. |
| revision | number | Revision of the file. |
| type | number | Type of the file. Possible values: BPMN, DMN, TEMPLATE_GENERIC, or TEMPLATE_SERVICE_TASK. |
| updated | date (in ISO-8601 format) | Date and time when the file was last updated. |
| updatedBy.id | string | Unique identifier of the user who last updated the file. |
| updatedBy.name | string | Name of the user who last updated the file. |