Skip to main content

Job Endpoints

Job Endpoints and Parameters

Retrieve Details about a Specific Job

Retrieve Messages of a Specific Job

Cancel a Specific Job

To learn more about the objects relations and how to use them in the API, go to the Object Relations section.

For more information about jobs, visit the Jobs: Admin Interface help page.

Retrieve Details about a Specific Job

To retrieve details about an existing job and its current state, use the GET {baseURL}/v3/jobs/{jobId} endpoint. Use various parameters to filter the jobs you want to display.

Note

Only app workflows can be used.

Users are able to see jobs run by them and jobs run on schedules shared via Collections.

Parameters

  • jobId (string): Required. Enter the Job ID for which you want to display details.

  • includeMessages (boolean): Optional. Can be left without a value. You can choose from the following values: ‘true’ and ‘false’. If this parameter is set to ‘false’, then a reduced object will be returned. When not specified, the ‘true’ value is used.

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

    {
  "id": "string",
  "appId": "string",
  "createDateTime": "2024-09-19T10:02:54.589Z",
  "status": "string",
  "disposition": "string",
  "outputs": [
    {
      "id": "string",
      "availableFormats": [
        "string"
      ],
      "fileName": "string"
    }
  ],
  "messages": [
    {
      "status": 0,
      "text": "string",
      "toolId": 0
    }
  ],
  "priority": "Default",
  "workerTag": "string",
  "runWithE2": true
}

  • 401: Unauthorized

  • 404: NotFound

Retrieve Messages of a Specific Job

To retrieve all messages of a specific job, use the GET {baseURL}/v3/jobs/{jobId}/messages endpoint.

Note

Only Curators can use this endpoint.

Parameters

  • jobId (string): Required. Enter the Job ID for which you want to display messages.

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

    {
  "status": 0,
  "text": "string",
  "toolId": 0
}

  • 401: Unauthorized

  • 404: NotFound

Cancel a Specific Job

To cancel a specific job, use the DELETE {baseURL}/v3/jobs/{jobId} endpoint. The job must be in "Queued" or "Running" state.

If you cancel a running job, it gets canceled. If you cancel a queued job, it gets deleted.

Note

Curators can cancel any jobs.

Other roles can cancel jobs they have created, triggered, or scheduled. It includes jobs shared with them through Collections, even if they are not the job owner.

Parameters

  • jobId (string): Required. Enter the Job ID you want to cancel.

curl -X 'DELETE' \
  'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

    • Response when you cancel a running job:

      {
  "message": "Cancelled Successfully."
}

    • Response when you cancel a queued job:

      {
  "message": "Deleted Successfully."
}

  • 400: BadRequest

    • Response when the job is not in ‘Queued’ or ‘Running’ state:

      {
  "message": "This job is not in 'Queued' or 'Running' state."
}

    • Response when the user making the API call does not have permission to cancel the job:

      {
  "message": "You do not have permission to cancel this job."
}

  • 401: Unauthorized

  • 404: NotFound

Objects Relations

If you want to get information about a specific job, you need a jobId. To obtain this jobId, use the GET {baseURL}/v3/workflows/{workflowId}/jobs endpoint. For more information about this endpoint, see the Workflow Endpoints help page.

Postman Requests

To know more about Postman requests, visit the How to Use Postman help page.