Get Job Status

GET

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

GET

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

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

1 {
2   "id": "job-9f8b7c6d-1234-4e56-8a9b-0c1d2e3f4a5b",
3   "name": "data-import-2024-06-01",
4   "status": "active",
5   "status_details": {
6     "progress": "45%",
7     "current_step": "validating data"
8   },
9   "error_details": {},
10   "steps": [
11     {
12       "id": "step-1a2b3c4d-5678-4e90-b123-456789abcdef",
13       "name": "extract",
14       "status": "completed",
15       "status_details": {
16         "records_extracted": 15000
17       },
18       "error_details": {},
19       "tasks": [
20         {
21           "id": "task-abc123ef-4567-890a-bcde-f1234567890a",
22           "name": "extract-from-source",
23           "status": "completed",
24           "status_details": {
25             "duration_seconds": 120
26           },
27           "error_details": {},
28           "error_stack": "",
29           "created_at": "2024-06-01T08:00:00Z",
30           "updated_at": "2024-06-01T08:02:00Z"
31         }
32       ],
33       "created_at": "2024-06-01T08:00:00Z",
34       "updated_at": "2024-06-01T08:02:00Z"
35     },
36     {
37       "id": "step-5f6e7d8c-9012-4b34-9cde-123456789abc",
38       "name": "validate",
39       "status": "active",
40       "status_details": {
41         "records_validated": 7000,
42         "errors_found": 3
43       },
44       "error_details": {},
45       "tasks": [
46         {
47           "id": "task-def456gh-7890-1234-ijkl-mnopqrstuvwx",
48           "name": "validate-schema",
49           "status": "active",
50           "status_details": {
51             "current_record": 7000
52           },
53           "error_details": {},
54           "error_stack": "",
55           "created_at": "2024-06-01T08:03:00Z",
56           "updated_at": "2024-06-01T08:10:00Z"
57         }
58       ],
59       "created_at": "2024-06-01T08:03:00Z",
60       "updated_at": "2024-06-01T08:10:00Z"
61     }
62   ],
63   "created_at": "2024-06-01T08:00:00Z",
64   "updated_at": "2024-06-01T08:10:00Z"
65 }

Get the status of a platform job.

Path parameters

namestringRequired

workspacestringRequired

Response

Successful Response

idstring

namestring

statusenum

Enumeration of possible job statuses. This enum represents the various states a job can be in during its lifecycle, from creation to a terminal state.

status_detailsmap from strings to any

error_detailsmap from strings to any

stepslist of objects

created_atdatetime

updated_atdatetime

Errors

404

Not Found Error

422

Unprocessable Entity Error