offer_tasks

Creates, updates, deletes, gets or lists an offer_tasks resource.

Overview

Name	offer_tasks
Type	Resource
Id	ovh.telephony.offer_tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	(wire: taskId)
action	string	Actual action that will be executed (convertToAlias, convertToSip, migrateToNewVoicemail, removeSimltaneousLines, switchServer, termination, updateFirmware, upgrade)
execution_date	string (date-time)	Planned execution date (wire: executionDate)
status	string	Current status of the task (doing, done, error, pause, todo)
type	string	Type of operation that will be executed (line, offer, option, phone)

list

Operation on a telephony offer

Name	Datatype	Description
task_id	integer	(wire: taskId)
action	string	Actual action that will be executed (convertToAlias, convertToSip, migrateToNewVoicemail, removeSimltaneousLines, switchServer, termination, updateFirmware, upgrade)
execution_date	string (date-time)	Planned execution date (wire: executionDate)
status	string	Current status of the task (doing, done, error, pause, todo)
type	string	Type of operation that will be executed (line, offer, option, phone)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, task_id		Get an offer task
list	select	billing_account	action, status, type, x_pagination_mode	List offer tasks
update	update	billing_account, task_id		Update an offer task

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 (=)
status	string	Filter the value of status property (=)
type	string	Filter the value of type 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 an offer task

SELECT
task_id,
action,
execution_date,
status,
type
FROM ovh.telephony.offer_tasks
WHERE billing_account = '{{ billing_account }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

List offer tasks

SELECT
task_id,
action,
execution_date,
status,
type
FROM ovh.telephony.offer_tasks
WHERE billing_account = '{{ billing_account }}' -- required
AND action = '{{ action }}'
AND status = '{{ status }}'
AND type = '{{ type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update an offer task

UPDATE ovh.telephony.offer_tasks
SET 
execution_date = '{{ execution_date }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND task_id = '{{ task_id }}' --required;