Tolgee Octri Demo
PUT/v2/projects/{projectId}/batch-jobs/{id}/cancel

Stop a batch operation

Stops a batch operation in a project when cancellation is possible. Use the operation and project identifiers to target the batch operation you want to stop.

2 parameters
idintegerrequired
The batch operation identifier, as a 64-bit integer.
projectIdintegerrequired
The project identifier, as a 64-bit integer.

5 status codes
200Confirms that the batch operation cancellation request was processed.
400Returned when a path parameter is invalid or the operation cannot be cancelled.
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 not authenticated.
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 access the requested resource.
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 batch operation 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 a path parameter is invalid. A 401 is returned when the request is unauthenticated, a 403 when the authenticated user lacks access, and a 404 when the project or batch operation does not exist. The id path parameter and projectId path parameter must be 64-bit integer identifiers.