order_follow_ups
Creates, updates, deletes, gets or lists an order_follow_ups resource.
Overview​
| Name | order_follow_ups |
| Type | Resource |
| Id | ovh.pack_xdsl.order_follow_ups |
Fields​
The following fields are returned by SELECT queries:
- list
Information about order follow up step
| Name | Datatype | Description |
|---|---|---|
name | string | Order follow up step name |
comments | array | Additional information about the step |
done_date | string (date-time) | Date when the step has been done (wire: doneDate) |
duration_unit | string | Unit used for the expected duration step (wire: durationUnit) |
expected_duration | integer | Expected duration step (wire: expectedDuration) |
status | string | Status of the step |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | pack_name | Get the order follow-up of an xDSL pack. Returns the steps of the pack order with their status, expected duration, completion date and comments. |
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"}}) |
pack_name | string | The internal name of your pack (wire: packName) |
SELECT examples​
- list
Get the order follow-up of an xDSL pack. Returns the steps of the pack order with their status, expected duration, completion date and comments.
SELECT
name,
comments,
done_date,
duration_unit,
expected_duration,
status
FROM ovh.pack_xdsl.order_follow_ups
WHERE pack_name = '{{ pack_name }}' -- required
;