ovh_pabx_dialplan_extension_condition_times

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

Overview

Name	ovh_pabx_dialplan_extension_condition_times
Type	Resource
Id	ovh.telephony.ovh_pabx_dialplan_extension_condition_times

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
condition_id	integer	(wire: conditionId)
time_from	string (time)	The time of the day when the extension will start to be executed (example: 15:04:05) (wire: timeFrom)
time_to	string (time)	The time of the day when the extension will stop to be executed (example: 15:04:05) (wire: timeTo)
week_day	string	The day of the week when the extension will be executed (friday, monday, saturday, sunday, thursday, tuesday, wednesday) (wire: weekDay)

list

Time condition

Name	Datatype	Description
condition_id	integer	(wire: conditionId)
time_from	string (time)	The time of the day when the extension will start to be executed (example: 15:04:05) (wire: timeFrom)
time_to	string (time)	The time of the day when the extension will stop to be executed (example: 15:04:05) (wire: timeTo)
week_day	string	The day of the week when the extension will be executed (friday, monday, saturday, sunday, thursday, tuesday, wednesday) (wire: weekDay)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, condition_id, dialplan_id, extension_id, service_name		Get a time condition
list	select	billing_account, dialplan_id, extension_id, service_name	x_pagination_mode	List time conditions
create	insert	billing_account, dialplan_id, extension_id, service_name, time_from, time_to, week_day		Create a time condition
update	update	billing_account, condition_id, dialplan_id, extension_id, service_name		Update a time condition
delete	delete	billing_account, condition_id, dialplan_id, extension_id, service_name		Delete a time condition

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)
condition_id	integer	(wire: conditionId)
dialplan_id	integer	(wire: dialplanId)
extension_id	integer	(wire: extensionId)
service_name	string	(wire: serviceName)
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 time condition

SELECT
condition_id,
time_from,
time_to,
week_day
FROM ovh.telephony.ovh_pabx_dialplan_extension_condition_times
WHERE billing_account = '{{ billing_account }}' -- required
AND condition_id = '{{ condition_id }}' -- required
AND dialplan_id = '{{ dialplan_id }}' -- required
AND extension_id = '{{ extension_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List time conditions

SELECT
condition_id,
time_from,
time_to,
week_day
FROM ovh.telephony.ovh_pabx_dialplan_extension_condition_times
WHERE billing_account = '{{ billing_account }}' -- required
AND dialplan_id = '{{ dialplan_id }}' -- required
AND extension_id = '{{ extension_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a time condition

INSERT INTO ovh.telephony.ovh_pabx_dialplan_extension_condition_times (
time_from,
time_to,
week_day,
billing_account,
dialplan_id,
extension_id,
service_name
)
SELECT 
'{{ time_from }}' /* required */,
'{{ time_to }}' /* required */,
'{{ week_day }}' /* required */,
'{{ billing_account }}',
'{{ dialplan_id }}',
'{{ extension_id }}',
'{{ service_name }}'
RETURNING
condition_id,
time_from,
time_to,
week_day
;

Manifest

# Description fields are for documentation purposes
- name: ovh_pabx_dialplan_extension_condition_times
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_times resource.
  - name: dialplan_id
    value: {{ dialplan_id }}
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_times resource.
  - name: extension_id
    value: {{ extension_id }}
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_times resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_times resource.
  - name: time_from
    value: "{{ time_from }}"
    description: |
      The time of the day when the extension will start to be executed
  - name: time_to
    value: "{{ time_to }}"
    description: |
      The time of the day when the extension will stop to be executed
  - name: week_day
    value: "{{ week_day }}"
    description: |
      The day of the week when the extension will be executed
    valid_values: ['friday', 'monday', 'saturday', 'sunday', 'thursday', 'tuesday', 'wednesday']

UPDATE examples

update

Update a time condition

UPDATE ovh.telephony.ovh_pabx_dialplan_extension_condition_times
SET 
time_from = '{{ time_from }}',
time_to = '{{ time_to }}',
week_day = '{{ week_day }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND condition_id = '{{ condition_id }}' --required
AND dialplan_id = '{{ dialplan_id }}' --required
AND extension_id = '{{ extension_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a time condition

DELETE FROM ovh.telephony.ovh_pabx_dialplan_extension_condition_times
WHERE billing_account = '{{ billing_account }}' --required
AND condition_id = '{{ condition_id }}' --required
AND dialplan_id = '{{ dialplan_id }}' --required
AND extension_id = '{{ extension_id }}' --required
AND service_name = '{{ service_name }}' --required
;