tasks

Creates, updates, deletes, gets or lists a tasks resource.

Overview

Name	tasks
Type	Resource
Id	ovh.telephony.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	(wire: taskId)
action	string	Action associated with the task
message	string	Potential failure reason of the task
object_created	string	Object potentially created at the end of the task (wire: objectCreated)
service_type	string	(wire: serviceType)
status	string	Status of the task (doing, done, error, pause, todo)

list

Operation on a telephony service

Name	Datatype	Description
task_id	integer	(wire: taskId)
action	string	Action associated with the task
message	string	Potential failure reason of the task
object_created	string	Object potentially created at the end of the task (wire: objectCreated)
service_type	string	(wire: serviceType)
status	string	Status of the task (doing, done, error, pause, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, task_id		Get a task
list	select	billing_account	action, service_type, status, x_pagination_mode	List tasks

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"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)
task_id	integer	(wire: taskId)
action	string	Filter the value of action property (=)
service_type	string	Filter the value of serviceType property (=) (wire: serviceType)
status	string	Filter the value of status property (=)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a task

SELECT
task_id,
action,
message,
object_created,
service_type,
status
FROM ovh.telephony.tasks
WHERE billing_account = '{{ billing_account }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

List tasks

SELECT
task_id,
action,
message,
object_created,
service_type,
status
FROM ovh.telephony.tasks
WHERE billing_account = '{{ billing_account }}' -- required
AND action = '{{ action }}'
AND service_type = '{{ service_type }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;