Get Job Step Task

GET

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

GET

/apis/jobs/v2/workspaces/:workspace/jobs/:job/steps/:step/tasks/:name

$ curl https://host.com/apis/jobs/v2/workspaces/workspace/jobs/job/steps/step/tasks/name \
>      -H "Content-Type: application/json"

1 {
2   "workspace": "analytics-team",
3   "step_id": "step-42",
4   "id": "a3f1c9d2-7b4e-4f8a-9c3d-2e5f7b8a9c1d",
5   "created_at": "2024-01-15T09:30:00Z",
6   "created_by": "jane.doe@example.com",
7   "updated_at": "2024-01-15T09:30:00Z",
8   "updated_by": "john.smith@example.com",
9   "entity_id": "a3f1c9d2-7b4e-4f8a-9c3d-2e5f7b8a9c1d",
10   "parent": "step-42",
11   "db_version": 3,
12   "name": "data-import-task",
13   "project": "customer-insights",
14   "status": "active",
15   "status_details": {
16     "progress": "75%",
17     "last_updated": "2024-01-15T09:25:00Z"
18   },
19   "error_details": {},
20   "error_stack": ""
21 }

Get a specific job step task.

Path parameters

jobstringRequired

stepstringRequired

namestringRequired

workspacestringRequired

Response

Successful Response

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

Workspace identifier

step_idstring

Parent step 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.

statusenumOptionalDefaults to pending

Task status

status_detailsmap from strings to anyOptional

Details about the task status

error_detailsmap from strings to anyOptional

Details about task errors

error_stackstringOptional

Error stack trace if applicable

Errors

404

Not Found Error

422

Unprocessable Entity Error