• Subcategories:
• Large Object (LOB) Attributes - FileContents
• Large Object (LOB) Attributes - FileWebImage

Documents REST Endpoints

Sort by

Task Path Method

Allocated Checklists/Allocated Tasks/Documents

The documents resource is a child of the allocatedChecklists resource. It is used to view, create, and update attachments for a document task type.

Create a document task type attachment

Method: post

Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents

Delete a document task type attachment

Method: delete

Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}

Get a document task type attachment

Method: get

Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}

Get all document task type attachments

Method: get

Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents

Update a document task type attachment

Method: patch

Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}