Skip to content

Commit 47c3638

Browse files
committed
docs: Detail Orchestration API job statuses. Resolves #9016
1 parent 47f6e69 commit 47c3638

File tree

1 file changed

+10
-27
lines changed

1 file changed

+10
-27
lines changed

docs/pages/reference/rest-api.mdx

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,15 @@ Example response:
310310
To retrieve statuses of previously triggered jobs, send a `POST` request with a
311311
payload including the `tokens` property.
312312

313+
In the `status` property of the payload, you can get the following statuses:
314+
315+
| Status | Description |
316+
| --- | --- |
317+
| `scheduled` | The job hasn't run yet |
318+
| `processing` | The job is currently running |
319+
| `missing_partition` | The job has failed |
320+
| `done` | The job has successfully completed |
321+
313322
Example request:
314323

315324
```bash{outputLines: 2-14}
@@ -318,9 +327,7 @@ curl \
318327
"action": "get",
319328
"tokens": [
320329
"e9a6a0c55885cea5371348500ce7d7dc",
321-
"d1329b6c8d152e734fc4dcf7307b1b58",
322-
"6f4ea38373663fffc4334a576574845b",
323-
"ea903b10634b2f3141b35a2529870e89"
330+
"d1329b6c8d152e734fc4dcf7307b1b58"
324331
]
325332
}' \
326333
-H "Authorization: EXAMPLE-API-TOKEN" \
@@ -356,30 +363,6 @@ Example response:
356363
"timezones": ["UTC"],
357364
"dataSources": ["default"]
358365
}
359-
},
360-
{
361-
"token": "6f4ea38373663fffc4334a576574845b",
362-
"table": "prod_pre_aggregations.orders_category_and_date_hod0x3hf_03krd5ns_1hop3hn",
363-
"status": "missing_partition",
364-
"selector": {
365-
"cubes": ["orders"],
366-
"preAggregations": ["orders.category_and_date"],
367-
"contexts": [{ "securityContext": { "tenant": "tenant_1" } }],
368-
"timezones": ["UTC"],
369-
"dataSources": ["default"]
370-
}
371-
},
372-
{
373-
"token": "ea903b10634b2f3141b35a2529870e89",
374-
"table": "prod_pre_aggregations.orders_category_and_date_mzfp445f_r2h2isa5_1hop3hn",
375-
"status": "missing_partition",
376-
"selector": {
377-
"cubes": ["orders"],
378-
"preAggregations": ["orders.category_and_date"],
379-
"contexts": [{ "securityContext": { "tenant": "tenant_1" } }],
380-
"timezones": ["UTC"],
381-
"dataSources": ["default"]
382-
}
383366
}
384367
]
385368
```

0 commit comments

Comments
 (0)