NInimbleway
Jobs

Trigger Run

Changed on

Trigger Run

post/v1/jobs/{job_id}/runs

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/jobs/{job_id}/runs
  • Auth
    • HTTP bearer
    • or API key in cookie token

Path parameters

job_idstring required

Request body

Response

Successful Response

created_atstring date-time required

When the run was created.

finished_atstring date-time nullable

When the run finished.

idstring required

Unique run identifier (run_<n>).

input_countinteger nullable

Number of input records processed.

job_idstring required

Identifier of the job this run belongs to.

result_countinteger nullable

Number of result records produced.

started_atstring date-time nullable

When the run started executing.

status'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING' required

Current run status.

triggered_by'schedule' | 'manual' required

What triggered the run: 'schedule' or 'manual'.

Changes

  • 167c81181daaRevision changes
    • info

      added optional request body

  • d4e4f170f4f4Revision changes
    • warning

      deleted the cookie request parameter token

    • info

      api operation id trigger_job_run_v2_jobs__job_id__runs_post removed and replaced with trigger_job_run_public_v1_api_v1_public_jobs__job_id__runs_post

    • info

      the endpoint scheme security APIKeyCookie was added to the API

    • info

      the endpoint scheme security HTTPBearer was added to the API

    • info

      endpoint deprecated