Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Passing a Delayed Execution Job
Updated on 2025-03-25 GMT+08:00

Passing a Delayed Execution Job

Function

This API is used to pass a delayed execution job.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/jobs/{jobRunId}/steps/{stepRunId}/delay-pass

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

pipelineRunId

Yes

String

Pipeline run ID.

jobRunId

Yes

String

Pipeline job ID.

stepRunId

Yes

String

Pipeline step ID.

project_id

Yes

String

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_id

Yes

String

Parameter description:

Pipeline ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

body

Yes

Object

Request body.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Parameter description:

Whether the operation is successful.

Value range:

None.

Example Requests

POST https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/dc73b5ed58a64ab7a469b9480e5f6632/pipeline-runs/164ef29bf79f4a82b8cba64250d3bf77/jobs/e94c5568aa8c45feb6fd364ed54c1f60/steps/2fb1acc4c9474534a58c8d0378a8b5cd/delay-pass

{ }

Example Responses

Status code: 200

Response body.

{
  "success" : true
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.