Update Job Step Status

PATCH

https://host.com/apis/jobs/v2/workspaces/:workspace/jobs/:job/steps/:name/status

PATCH

/apis/jobs/v2/workspaces/:workspace/jobs/:job/steps/:name/status

$ curl -X PATCH https://host.com/apis/jobs/v2/workspaces/workspace/jobs/job/steps/name/status \
>      -H "Content-Type: application/json" \
>      -d '{
>   "status": "active"
> }'

1 {
2   "workspace": "analytics_team",
3   "attempt_id": "attempt_20240612_01",
4   "id": "step_123e4567-e89b-12d3-a456-426614174000",
5   "created_at": "2024-01-15T09:30:00Z",
6   "created_by": "jane.doe@example.com",
7   "updated_at": "2024-04-20T14:45:00Z",
8   "updated_by": "john.smith@example.com",
9   "entity_id": "step_123e4567-e89b-12d3-a456-426614174000",
10   "parent": "attempt_20240612_01",
11   "db_version": 3,
12   "name": "DataProcessingStep",
13   "project": "customer_segmentation",
14   "config": {},
15   "status": "active",
16   "status_details": {},
17   "error_details": {}
18 }

Update a job step status.

Path parameters

jobstringRequired

namestringRequired

workspacestringRequired

Request

This endpoint expects an object.

statusenumRequired

The new status to set for the job.

status_detailsmap from strings to anyOptional

Optional status details related to the status update.

error_detailsmap from strings to anyOptional

Optional error details related to the status update.

Response

Successful Response

workspacestringformat: "^[\w\-\+.@:]+$"

Workspace identifier

attempt_idstring

Parent attempt ID

idstringRead-only

created_atdatetimeRead-only

created_bystring or nullRead-only

updated_atdatetimeRead-only

updated_bystring or nullRead-only

entity_idstringRead-only

Alias for id for backwards compatibility.

parentstringRead-only

Parent entity ID for nested entities.

db_versionintegerRead-only

Database version of the entity for optimistic locking.

namestringOptionalDefaults to

Entity name within the workspace

projectstringOptional

The name of the project associated with this entity.

configmap from strings to anyOptional

Configuration for the step

statusenumOptionalDefaults to created

Step status

status_detailsmap from strings to anyOptional

Status details

error_detailsmap from strings to anyOptional

Error details if applicable

Errors

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error