• Subcategories:
• Allocated Checklist Task Attributes
• Attachments
• Journey Task Properties
• Large Object (LOB) Attributes - AddToCalendar
• Large Object (LOB) Attributes - Notes
• Learning Content Items List of Values
• Notifications
• Questionnaire Responses

Tasks REST Endpoints

Sort by

Task Path Method

Worker Journeys/Tasks

The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.

Check task completion

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/checkTaskCompletion

Create a task

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks

Delete a task

Method: delete

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}

Get a task

Method: get

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}

Get all tasks

Method: get

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks

Initiate process automation

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/invokeProcessAutomation

Navigate to a task

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateNavigationURL

Navigate to an application task

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateNavigationDetails

Reassign a task

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/reassign

Send a task reminder

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/sendReminder

Update a task

Method: patch

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}

Update status

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/updateStatus

Upload a document

Method: post

Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/copyToDocumentRecords