order_follow_ups
Creates, updates, deletes, gets or lists an order_follow_ups resource.
Overview​
| Name | order_follow_ups |
| Type | Resource |
| Id | ovh.me.order_follow_ups |
Fields​
The following fields are returned by SELECT queries:
- list
Follow up history of an order
| Name | Datatype | Description |
|---|---|---|
history | array | Step history of order follow-up |
status | string | Step status of order follow-up (DOING, DONE, ERROR, TODO) |
step | string | Step of order follow-up (AVAILABLE, DELIVERING, VALIDATED, VALIDATING) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | order_id | Return tracking of the order (Beta version) |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
order_id | integer | (wire: orderId) |
SELECT examples​
- list
Return tracking of the order (Beta version)
SELECT
history,
status,
step
FROM ovh.me.order_follow_ups
WHERE order_id = '{{ order_id }}' -- required
;