Folders and Files
Attachments > results returns a list of work order folders and files.
Folder Object
A folder object includes folder information and attachments.
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| id | integer | "id": 1 | Folder ID. Read-only. |
| name | string | "name": "Documents" | Folder name. "Documents," "Misc," or "Your Custom Folder Name." |
| type | string | "type": "document" OR "type": "slot" |
Folder type. A document folder includes an array of Client Documents. A slot folder is defined for the default Misc folder and Custom Folders associated with Deliverables. |
| metadata | object | "metadata": {} | Total number of attachment results. |
| results | array | "results": [] | Returns an array of File Objects. |
Tip: Misc and custom folders also return the maximum number of files allowed and the minimum and maximum file size. You can not upload an empty file.
Examples
File Object
A file object includes attachment details. You can locate files in the folder object > results.
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| id | integer | "id": 176 | File ID. |
| author | object | "author": {} | User information for file uploader. |
| reviewer | object | "reviewer": {} | User information for file approver. Used when folder type = slot. |
| created | object | "created": {} | File Create Date. Read only. Dates and Times. |
| file | object | "file": {} | File type, thumbnail, name, size, link, type, and icon. File links do not have a max character length. If stored, make sure your field supports URLs up to 1024 characters. |
| show_before_assignment | boolean | "show_before_assignment":false | Make Public or Private. For public, set to true. |
| task | object | "task": { "id": 22578 } |
Task id associated with file (if applicable). |
| notes | string | "notes": "Client Document Note" | File Note. |
| status | string | "status":"approved" | Approval Status. Used when folder type = slot. |
| status_description | string | "status_description":"Denied reason." | Denied Reason. Used when folder type = slot. |
| reviewed | object | "reviewed": {} | File Reviewed Date. Read only. Dates and Times. Used when folder type = slot. |
| folder_id | integer | "folder_id":5153 | File Folder ID. Used when folder type = slot. |
Examples
File options will vary depending on the folder type.