Tolgee Octri Demo
PUT/v2/projects/{projectId}/tasks/{taskNumber}/cancel

Cancel a task

Cancels a task in a project. Use projectId and taskNumber to identify the task to cancel; the response contains the task after the operation.

2 parameters
taskNumberintegerrequired
The 64-bit integer number of the task to cancel.
projectIdintegerrequired
The 64-bit integer identifier of the project containing the task.

5 status codes
200Returns the task object, including its current state and task details.
agencyobjectoptional
assigneesarray<object>required
authorobjectoptional
baseCharacterCountintegerrequired
baseWordCountintegerrequired
branchNamestringoptional
closedAtintegeroptional
createdAtintegeroptional
descriptionstringrequired
doneItemsintegerrequired
dueDateintegeroptional
languageobjectrequired
namestringoptional
numberintegerrequired
originBranchNamestringoptional
statestringrequired
Allowed:NEWIN_PROGRESSFINISHEDCANCELED
totalItemsintegerrequired
typestringrequired
Allowed:TRANSLATEREVIEW
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to cancel the task.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or task does not exist.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the request is unauthenticated. A 403 is returned when the authenticated user cannot cancel the task. A 404 is returned when the projectId path parameter or taskNumber path parameter does not identify an existing project task.