Sign in
V2
Parse

Cancel Parse Job

Cancel a running parse job.

Stops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.

post/api/v2/parse/{job_id}/cancel

Path parameters

job_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring required

Unique parse job identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project this job belongs to

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

error_messagestring nullable

Error details when status is FAILED

namestring nullable

Optional display name for this parse job

tierstring nullable

Parsing tier used for this job

Example response

{
  "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "Q4 Financial Report",
  "tier": "fast"
}

Changes

Changed in 2 of the 33 revisions of this API.3

  • b17341164de92See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1bbc901f8c0d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog