Skip to content

Commit

Permalink
docs: Detail Orchestration API job statuses. Resolves #9016
Browse files Browse the repository at this point in the history
  • Loading branch information
igorlukanin committed Dec 10, 2024
1 parent 47f6e69 commit 47c3638
Showing 1 changed file with 10 additions and 27 deletions.
37 changes: 10 additions & 27 deletions docs/pages/reference/rest-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,15 @@ Example response:
To retrieve statuses of previously triggered jobs, send a `POST` request with a
payload including the `tokens` property.

In the `status` property of the payload, you can get the following statuses:

| Status | Description |
| --- | --- |
| `scheduled` | The job hasn't run yet |
| `processing` | The job is currently running |
| `missing_partition` | The job has failed |
| `done` | The job has successfully completed |

Example request:

```bash{outputLines: 2-14}
Expand All @@ -318,9 +327,7 @@ curl \
"action": "get",
"tokens": [
"e9a6a0c55885cea5371348500ce7d7dc",
"d1329b6c8d152e734fc4dcf7307b1b58",
"6f4ea38373663fffc4334a576574845b",
"ea903b10634b2f3141b35a2529870e89"
"d1329b6c8d152e734fc4dcf7307b1b58"
]
}' \
-H "Authorization: EXAMPLE-API-TOKEN" \
Expand Down Expand Up @@ -356,30 +363,6 @@ Example response:
"timezones": ["UTC"],
"dataSources": ["default"]
}
},
{
"token": "6f4ea38373663fffc4334a576574845b",
"table": "prod_pre_aggregations.orders_category_and_date_hod0x3hf_03krd5ns_1hop3hn",
"status": "missing_partition",
"selector": {
"cubes": ["orders"],
"preAggregations": ["orders.category_and_date"],
"contexts": [{ "securityContext": { "tenant": "tenant_1" } }],
"timezones": ["UTC"],
"dataSources": ["default"]
}
},
{
"token": "ea903b10634b2f3141b35a2529870e89",
"table": "prod_pre_aggregations.orders_category_and_date_mzfp445f_r2h2isa5_1hop3hn",
"status": "missing_partition",
"selector": {
"cubes": ["orders"],
"preAggregations": ["orders.category_and_date"],
"contexts": [{ "securityContext": { "tenant": "tenant_1" } }],
"timezones": ["UTC"],
"dataSources": ["default"]
}
}
]
```
Expand Down

0 comments on commit 47c3638

Please sign in to comment.