scheduler_events

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

Overview

Name	scheduler_events
Type	Resource
Id	ovh.telephony.scheduler_events

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
categories	string	The category of the event (holidays, scheduler1, scheduler2, scheduler3)
date_end	string (date-time)	The ending date of the event (wire: dateEnd)
date_start	string (date-time)	The beginning date of the event (wire: dateStart)
description	string
title	string
uid	string	The unique ICS event identifier

list

Scheduled event

Name	Datatype	Description
categories	string	The category of the event (holidays, scheduler1, scheduler2, scheduler3)
date_end	string (date-time)	The ending date of the event (wire: dateEnd)
date_start	string (date-time)	The beginning date of the event (wire: dateStart)
description	string
title	string
uid	string	The unique ICS event identifier

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name, uid		Get a scheduler event
list	select	billing_account, service_name	categories, date_end.from, date_end.to, date_start.from, date_start.to, x_pagination_mode	List scheduler events
create	insert	billing_account, service_name, category, date_end, date_start, title		Create a scheduler event
update	update	billing_account, service_name, uid		Update a scheduler event
delete	delete	billing_account, service_name, uid		Delete a scheduler event

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)
service_name	string	(wire: serviceName)
uid	string	The unique ICS event identifier
categories	string	Filter the value of categories property (=)
date_end.from	string (date-time)	Filter the value of dateEnd property (>=) (wire: dateEnd.from)
date_end.to	string (date-time)	Filter the value of dateEnd property (<=) (wire: dateEnd.to)
date_start.from	string (date-time)	Filter the value of dateStart property (>=) (wire: dateStart.from)
date_start.to	string (date-time)	Filter the value of dateStart property (<=) (wire: dateStart.to)
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 scheduler event

SELECT
categories,
date_end,
date_start,
description,
title,
uid
FROM ovh.telephony.scheduler_events
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND uid = '{{ uid }}' -- required
;

list

List scheduler events

SELECT
categories,
date_end,
date_start,
description,
title,
uid
FROM ovh.telephony.scheduler_events
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND categories = '{{ categories }}'
AND date_end.from = '{{ date_end.from }}'
AND date_end.to = '{{ date_end.to }}'
AND date_start.from = '{{ date_start.from }}'
AND date_start.to = '{{ date_start.to }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a scheduler event

INSERT INTO ovh.telephony.scheduler_events (
category,
date_end,
date_start,
description,
title,
uid,
billing_account,
service_name
)
SELECT 
'{{ category }}' /* required */,
'{{ date_end }}' /* required */,
'{{ date_start }}' /* required */,
'{{ description }}',
'{{ title }}' /* required */,
'{{ uid }}',
'{{ billing_account }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: scheduler_events
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the scheduler_events resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the scheduler_events resource.
  - name: category
    value: "{{ category }}"
    description: |
      Scheculer category
    valid_values: ['holidays', 'scheduler1', 'scheduler2', 'scheduler3']
  - name: date_end
    value: "{{ date_end }}"
    description: |
      The ending date of the event
  - name: date_start
    value: "{{ date_start }}"
    description: |
      The beginning date of the event
  - name: description
    value: "{{ description }}"
    description: |
      The descritpion of the event
  - name: title
    value: "{{ title }}"
    description: |
      The title of the event
  - name: uid
    value: "{{ uid }}"
    description: |
      The unique ICS event identifier

UPDATE examples

update

Update a scheduler event

UPDATE ovh.telephony.scheduler_events
SET 
categories = '{{ categories }}',
date_end = '{{ date_end }}',
date_start = '{{ date_start }}',
description = '{{ description }}',
title = '{{ title }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required
AND uid = '{{ uid }}' --required;

DELETE examples

delete

Delete a scheduler event

DELETE FROM ovh.telephony.scheduler_events
WHERE billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required
AND uid = '{{ uid }}' --required
;