REST Endpoints
All Endpoints
| Task | Method | Path |
|---|---|---|
| Add Case Data | post | /cases/{id}/casedata |
| Add a Case Comment | post | /cases/{id}/comments |
| Add a Case Milestone | post | /cases/{id}/milestones/{milestonename} |
| Add a Case Stakeholder | post | /cases/{id}/stakeholders |
| Add a Task Attachment | post | /tasks/{id}/attachments |
| Add a Task Comment | post | /tasks/{id}/comments |
| Archive Process Instances | post | /archives |
| Create a Case Activity | post | /cases/{id}/activities/{activityDefinitionId} |
| Create a Process Instance | post | /processes |
| Create a Task | post | /tasks |
| Create a To-Do Task | post | /tasks/todoTask |
| Delete a Task Attachment | delete | /tasks/{id}/attachments/{attachmentName} |
| Perform an Action on Tasks | put | /tasks |
| Retrieve Application Information | get | /runtime |
| Retrieve Case Activities | get | /cases/{id}/activities |
| Retrieve Case Comments | get | /cases/{id}/comments |
| Retrieve Case Data | get | /cases/{id}/casedata |
| Retrieve Case Milestones | get | /cases/{id}/milestones |
| Retrieve Case Stakeholders | get | /cases/{id}/stakeholders |
| Retrieve Cases | get | /cases |
| Retrieve Custom Task Lists | get | /tasks/views |
| Retrieve Identities | get | /identities |
| Retrieve Process Definitions | get | /process-definitions |
| Retrieve Process Instances | get | /processes |
| Retrieve Task Attachments | get | /tasks/{id}/attachments |
| Retrieve Task Comments | get | /tasks/{id}/comments |
| Retrieve Task History | get | /tasks/{id}/history |
| Retrieve Task Payload | get | /tasks/{id}/summaryField |
| Retrieve To-Do Tasks | get | /tasks/{id}/todoTasks |
| Retrieve a Case | get | /cases/{id} |
| Retrieve a Group | get | /identities/group/{groupid} |
| Retrieve a Process Instance Archive | get | /archives/{id} |
| Retrieve a Role | get | /identities/role/{roleid} |
| Retrieve a Task | get | /tasks/{id} |
| Retrieve a Task Attachment as a Stream | get | /tasks/{id}/attachments/{attachmentName}/stream |
| Retrieve a Task Attachment by Name | get | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Form | get | /tasks/{id}/form |
| Retrieve a Task List | get | /tasks |
| Retrieve a Task View | get | /tasks/views/{viewname} |
| Retrieve a User | get | /identities/user/{userid} |
| Update Task Payload | post | /tasks/{id}/summaryField |
| Update a Task | put | /tasks/{id} |
| Task | Method | Path |
|---|---|---|
| Add Case Data | post | /cases/{id}/casedata |
| Add a Case Comment | post | /cases/{id}/comments |
| Add a Case Milestone | post | /cases/{id}/milestones/{milestonename} |
| Add a Case Stakeholder | post | /cases/{id}/stakeholders |
| Add a Task Attachment | post | /tasks/{id}/attachments |
| Add a Task Comment | post | /tasks/{id}/comments |
| Archive Process Instances | post | /archives |
| Create a Case Activity | post | /cases/{id}/activities/{activityDefinitionId} |
| Create a Process Instance | post | /processes |
| Create a Task | post | /tasks |
| Create a To-Do Task | post | /tasks/todoTask |
| Delete a Task Attachment | delete | /tasks/{id}/attachments/{attachmentName} |
| Perform an Action on Tasks | put | /tasks |
| Retrieve Application Information | get | /runtime |
| Retrieve Case Activities | get | /cases/{id}/activities |
| Retrieve Case Comments | get | /cases/{id}/comments |
| Retrieve Case Data | get | /cases/{id}/casedata |
| Retrieve Case Milestones | get | /cases/{id}/milestones |
| Retrieve Case Stakeholders | get | /cases/{id}/stakeholders |
| Retrieve Cases | get | /cases |
| Retrieve Custom Task Lists | get | /tasks/views |
| Retrieve Identities | get | /identities |
| Retrieve Process Definitions | get | /process-definitions |
| Retrieve Process Instances | get | /processes |
| Retrieve Task Attachments | get | /tasks/{id}/attachments |
| Retrieve Task Comments | get | /tasks/{id}/comments |
| Retrieve Task History | get | /tasks/{id}/history |
| Retrieve Task Payload | get | /tasks/{id}/summaryField |
| Retrieve To-Do Tasks | get | /tasks/{id}/todoTasks |
| Retrieve a Case | get | /cases/{id} |
| Retrieve a Group | get | /identities/group/{groupid} |
| Retrieve a Process Instance Archive | get | /archives/{id} |
| Retrieve a Role | get | /identities/role/{roleid} |
| Retrieve a Task | get | /tasks/{id} |
| Retrieve a Task Attachment as a Stream | get | /tasks/{id}/attachments/{attachmentName}/stream |
| Retrieve a Task Attachment by Name | get | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Form | get | /tasks/{id}/form |
| Retrieve a Task List | get | /tasks |
| Retrieve a Task View | get | /tasks/views/{viewname} |
| Retrieve a User | get | /identities/user/{userid} |
| Update Task Payload | post | /tasks/{id}/summaryField |
| Update a Task | put | /tasks/{id} |
All Endpoints
| Task | Method | Path |
|---|---|---|
| Archive Process Instances | post | /archives |
| Retrieve a Process Instance Archive | get | /archives/{id} |
| Retrieve Cases | get | /cases |
| Retrieve a Case | get | /cases/{id} |
| Retrieve Case Activities | get | /cases/{id}/activities |
| Create a Case Activity | post | /cases/{id}/activities/{activityDefinitionId} |
| Retrieve Case Data | get | /cases/{id}/casedata |
| Add Case Data | post | /cases/{id}/casedata |
| Retrieve Case Comments | get | /cases/{id}/comments |
| Add a Case Comment | post | /cases/{id}/comments |
| Retrieve Case Milestones | get | /cases/{id}/milestones |
| Add a Case Milestone | post | /cases/{id}/milestones/{milestonename} |
| Retrieve Case Stakeholders | get | /cases/{id}/stakeholders |
| Add a Case Stakeholder | post | /cases/{id}/stakeholders |
| Retrieve Identities | get | /identities |
| Retrieve a Group | get | /identities/group/{groupid} |
| Retrieve a Role | get | /identities/role/{roleid} |
| Retrieve a User | get | /identities/user/{userid} |
| Retrieve Process Definitions | get | /process-definitions |
| Retrieve Process Instances | get | /processes |
| Create a Process Instance | post | /processes |
| Retrieve Application Information | get | /runtime |
| Retrieve a Task List | get | /tasks |
| Create a Task | post | /tasks |
| Perform an Action on Tasks | put | /tasks |
| Create a To-Do Task | post | /tasks/todoTask |
| Retrieve Custom Task Lists | get | /tasks/views |
| Retrieve a Task View | get | /tasks/views/{viewname} |
| Retrieve a Task | get | /tasks/{id} |
| Update a Task | put | /tasks/{id} |
| Retrieve Task Attachments | get | /tasks/{id}/attachments |
| Add a Task Attachment | post | /tasks/{id}/attachments |
| Delete a Task Attachment | delete | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Attachment by Name | get | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Attachment as a Stream | get | /tasks/{id}/attachments/{attachmentName}/stream |
| Retrieve Task Comments | get | /tasks/{id}/comments |
| Add a Task Comment | post | /tasks/{id}/comments |
| Retrieve a Task Form | get | /tasks/{id}/form |
| Retrieve Task History | get | /tasks/{id}/history |
| Retrieve Task Payload | get | /tasks/{id}/summaryField |
| Update Task Payload | post | /tasks/{id}/summaryField |
| Retrieve To-Do Tasks | get | /tasks/{id}/todoTasks |
| Task | Method | Path |
|---|---|---|
| Archive Process Instances | post | /archives |
| Retrieve a Process Instance Archive | get | /archives/{id} |
| Retrieve Cases | get | /cases |
| Retrieve a Case | get | /cases/{id} |
| Retrieve Case Activities | get | /cases/{id}/activities |
| Create a Case Activity | post | /cases/{id}/activities/{activityDefinitionId} |
| Retrieve Case Data | get | /cases/{id}/casedata |
| Add Case Data | post | /cases/{id}/casedata |
| Retrieve Case Comments | get | /cases/{id}/comments |
| Add a Case Comment | post | /cases/{id}/comments |
| Retrieve Case Milestones | get | /cases/{id}/milestones |
| Add a Case Milestone | post | /cases/{id}/milestones/{milestonename} |
| Retrieve Case Stakeholders | get | /cases/{id}/stakeholders |
| Add a Case Stakeholder | post | /cases/{id}/stakeholders |
| Retrieve Identities | get | /identities |
| Retrieve a Group | get | /identities/group/{groupid} |
| Retrieve a Role | get | /identities/role/{roleid} |
| Retrieve a User | get | /identities/user/{userid} |
| Retrieve Process Definitions | get | /process-definitions |
| Retrieve Process Instances | get | /processes |
| Create a Process Instance | post | /processes |
| Retrieve Application Information | get | /runtime |
| Retrieve a Task List | get | /tasks |
| Create a Task | post | /tasks |
| Perform an Action on Tasks | put | /tasks |
| Create a To-Do Task | post | /tasks/todoTask |
| Retrieve Custom Task Lists | get | /tasks/views |
| Retrieve a Task View | get | /tasks/views/{viewname} |
| Retrieve a Task | get | /tasks/{id} |
| Update a Task | put | /tasks/{id} |
| Retrieve Task Attachments | get | /tasks/{id}/attachments |
| Add a Task Attachment | post | /tasks/{id}/attachments |
| Delete a Task Attachment | delete | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Attachment by Name | get | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Attachment as a Stream | get | /tasks/{id}/attachments/{attachmentName}/stream |
| Retrieve Task Comments | get | /tasks/{id}/comments |
| Add a Task Comment | post | /tasks/{id}/comments |
| Retrieve a Task Form | get | /tasks/{id}/form |
| Retrieve Task History | get | /tasks/{id}/history |
| Retrieve Task Payload | get | /tasks/{id}/summaryField |
| Update Task Payload | post | /tasks/{id}/summaryField |
| Retrieve To-Do Tasks | get | /tasks/{id}/todoTasks |
All Endpoints
| Task | Method | Path |
|---|---|---|
| Delete a Task Attachment | delete | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Process Instance Archive | get | /archives/{id} |
| Retrieve Cases | get | /cases |
| Retrieve a Case | get | /cases/{id} |
| Retrieve Case Activities | get | /cases/{id}/activities |
| Retrieve Case Data | get | /cases/{id}/casedata |
| Retrieve Case Comments | get | /cases/{id}/comments |
| Retrieve Case Milestones | get | /cases/{id}/milestones |
| Retrieve Case Stakeholders | get | /cases/{id}/stakeholders |
| Retrieve Identities | get | /identities |
| Retrieve a Group | get | /identities/group/{groupid} |
| Retrieve a Role | get | /identities/role/{roleid} |
| Retrieve a User | get | /identities/user/{userid} |
| Retrieve Process Definitions | get | /process-definitions |
| Retrieve Process Instances | get | /processes |
| Retrieve Application Information | get | /runtime |
| Retrieve a Task List | get | /tasks |
| Retrieve Custom Task Lists | get | /tasks/views |
| Retrieve a Task View | get | /tasks/views/{viewname} |
| Retrieve a Task | get | /tasks/{id} |
| Retrieve Task Attachments | get | /tasks/{id}/attachments |
| Retrieve a Task Attachment by Name | get | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Attachment as a Stream | get | /tasks/{id}/attachments/{attachmentName}/stream |
| Retrieve Task Comments | get | /tasks/{id}/comments |
| Retrieve a Task Form | get | /tasks/{id}/form |
| Retrieve Task History | get | /tasks/{id}/history |
| Retrieve Task Payload | get | /tasks/{id}/summaryField |
| Retrieve To-Do Tasks | get | /tasks/{id}/todoTasks |
| Archive Process Instances | post | /archives |
| Create a Case Activity | post | /cases/{id}/activities/{activityDefinitionId} |
| Add Case Data | post | /cases/{id}/casedata |
| Add a Case Comment | post | /cases/{id}/comments |
| Add a Case Milestone | post | /cases/{id}/milestones/{milestonename} |
| Add a Case Stakeholder | post | /cases/{id}/stakeholders |
| Create a Process Instance | post | /processes |
| Create a Task | post | /tasks |
| Create a To-Do Task | post | /tasks/todoTask |
| Add a Task Attachment | post | /tasks/{id}/attachments |
| Add a Task Comment | post | /tasks/{id}/comments |
| Update Task Payload | post | /tasks/{id}/summaryField |
| Perform an Action on Tasks | put | /tasks |
| Update a Task | put | /tasks/{id} |
| Task | Method | Path |
|---|---|---|
| Delete a Task Attachment | delete | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Process Instance Archive | get | /archives/{id} |
| Retrieve Cases | get | /cases |
| Retrieve a Case | get | /cases/{id} |
| Retrieve Case Activities | get | /cases/{id}/activities |
| Retrieve Case Data | get | /cases/{id}/casedata |
| Retrieve Case Comments | get | /cases/{id}/comments |
| Retrieve Case Milestones | get | /cases/{id}/milestones |
| Retrieve Case Stakeholders | get | /cases/{id}/stakeholders |
| Retrieve Identities | get | /identities |
| Retrieve a Group | get | /identities/group/{groupid} |
| Retrieve a Role | get | /identities/role/{roleid} |
| Retrieve a User | get | /identities/user/{userid} |
| Retrieve Process Definitions | get | /process-definitions |
| Retrieve Process Instances | get | /processes |
| Retrieve Application Information | get | /runtime |
| Retrieve a Task List | get | /tasks |
| Retrieve Custom Task Lists | get | /tasks/views |
| Retrieve a Task View | get | /tasks/views/{viewname} |
| Retrieve a Task | get | /tasks/{id} |
| Retrieve Task Attachments | get | /tasks/{id}/attachments |
| Retrieve a Task Attachment by Name | get | /tasks/{id}/attachments/{attachmentName} |
| Retrieve a Task Attachment as a Stream | get | /tasks/{id}/attachments/{attachmentName}/stream |
| Retrieve Task Comments | get | /tasks/{id}/comments |
| Retrieve a Task Form | get | /tasks/{id}/form |
| Retrieve Task History | get | /tasks/{id}/history |
| Retrieve Task Payload | get | /tasks/{id}/summaryField |
| Retrieve To-Do Tasks | get | /tasks/{id}/todoTasks |
| Archive Process Instances | post | /archives |
| Create a Case Activity | post | /cases/{id}/activities/{activityDefinitionId} |
| Add Case Data | post | /cases/{id}/casedata |
| Add a Case Comment | post | /cases/{id}/comments |
| Add a Case Milestone | post | /cases/{id}/milestones/{milestonename} |
| Add a Case Stakeholder | post | /cases/{id}/stakeholders |
| Create a Process Instance | post | /processes |
| Create a Task | post | /tasks |
| Create a To-Do Task | post | /tasks/todoTask |
| Add a Task Attachment | post | /tasks/{id}/attachments |
| Add a Task Comment | post | /tasks/{id}/comments |
| Update Task Payload | post | /tasks/{id}/summaryField |
| Perform an Action on Tasks | put | /tasks |
| Update a Task | put | /tasks/{id} |