CTctrlplanedev

Update job status

Changed on

Updates the status of a specific job by ID.

put/v1/workspaces/{workspaceId}/jobs/{jobId}/status

Request

  • Base URL
    http://localhost:3001/api
  • URL
    http://localhost:3001/api/v1/workspaces/{workspaceId}/jobs/{jobId}/status
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

workspaceIdstring required

ID of the workspace

jobIdstring required

ID of the job

Request body

status'cancelled' | 'skipped' | 'inProgress' | 'actionRequired' | 'pending' | 'failure' | 'invalidJobAgent' | 'invalidIntegration' | 'externalRunNotFound' | 'successful' | 'queued' required

Response

Update job status

idstring required
messagestring required

Changes

  • 961b089028c7Revision changes
    • breaking

      added the new required request property

    • breaking

      the request's body type changed from string to object

    • info

      request body enum value removed actionRequired

    • info

      request body enum value removed cancelled

    • info

      request body enum value removed externalRunNotFound

    • info

      request body enum value removed failure

    • info

      request body enum value removed inProgress

    • info

      request body enum value removed invalidIntegration

    • info

      request body enum value removed invalidJobAgent

    • info

      request body enum value removed pending

    • info

      request body enum value removed queued

    • info

      request body enum value removed skipped

    • info

      request body enum value removed successful