service_resource_accounts

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

Overview

Name	service_resource_accounts
Type	Resource
Id	ovh.email_exchange.service_resource_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	task pending id (wire: taskPendingId)
display_name	string	name of resource (wire: displayName)
add_organizer_to_subject	boolean	meeting organizer's name is used as the subject of the meeting request (wire: addOrganizerToSubject)
allow_conflict	boolean	resource can be scheduled by more than one person during the same time period (wire: allowConflict)
booking_window	integer	maximum number of days in advance that the resource can be reserved (wire: bookingWindow)
capacity	integer	number of the same equipment or capacity of a room
company	string	Company name
creation_date	string (date-time)	Creation date (wire: creationDate)
delete_comments	boolean	remove any text in the message body of incoming meeting requests on resourceAccount (wire: deleteComments)
delete_subject	boolean	remove email subject of incoming meeting requests on resourceAccount (wire: deleteSubject)
location	string	resource location name
maximum_duration	integer	maximum duration in minutes for meeting requests (wire: maximumDuration)
resource_email_address	string	resource as email (wire: resourceEmailAddress)
show_meeting_details	string	granted right on a calendar of that resourceAccount (availabilityOnly, limitedDetails, reviewer) (wire: showMeetingDetails)
state	string	account state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)
type	string	resource type (equipment, room)

list

Exchange resource account

Name	Datatype	Description
task_pending_id	integer	task pending id (wire: taskPendingId)
display_name	string	name of resource (wire: displayName)
add_organizer_to_subject	boolean	meeting organizer's name is used as the subject of the meeting request (wire: addOrganizerToSubject)
allow_conflict	boolean	resource can be scheduled by more than one person during the same time period (wire: allowConflict)
booking_window	integer	maximum number of days in advance that the resource can be reserved (wire: bookingWindow)
capacity	integer	number of the same equipment or capacity of a room
company	string	Company name
creation_date	string (date-time)	Creation date (wire: creationDate)
delete_comments	boolean	remove any text in the message body of incoming meeting requests on resourceAccount (wire: deleteComments)
delete_subject	boolean	remove email subject of incoming meeting requests on resourceAccount (wire: deleteSubject)
location	string	resource location name
maximum_duration	integer	maximum duration in minutes for meeting requests (wire: maximumDuration)
resource_email_address	string	resource as email (wire: resourceEmailAddress)
show_meeting_details	string	granted right on a calendar of that resourceAccount (availabilityOnly, limitedDetails, reviewer) (wire: showMeetingDetails)
state	string	account state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)
type	string	resource type (equipment, room)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name, resource_email_address		Get a resource account. Returns the type, capacity, location, booking settings and state of the room or equipment resource account.
list	select	exchange_service, organization_name	company, resource_email_address, x_pagination_mode	List resource accounts. Returns the email addresses of the room and equipment resource accounts. Filter them by resourceEmailAddress or company.
create	insert	exchange_service, organization_name, capacity, resource_email_address, type		Create a resource account. Creates a room or equipment resource account from its resourceEmailAddress and capacity, and returns the task.
update	update	exchange_service, organization_name, resource_email_address		Update a resource account. Updates the display name, capacity, location and booking settings of the resource account, such as allowConflict, bookingWindow or maximumDuration.
delete	delete	exchange_service, organization_name, resource_email_address		Delete a resource account. Deletes the resource account (room or equipment) and its delegates, and returns the 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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organization_name	string	The internal name of your exchange organization (wire: organizationName)
resource_email_address	string	resource as email (wire: resourceEmailAddress)
company	string	Filter the value of company property (like)
resource_email_address	string	Filter the value of resourceEmailAddress property (like) (wire: resourceEmailAddress)
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 resource account. Returns the type, capacity, location, booking settings and state of the room or equipment resource account.

SELECT
task_pending_id,
display_name,
add_organizer_to_subject,
allow_conflict,
booking_window,
capacity,
company,
creation_date,
delete_comments,
delete_subject,
location,
maximum_duration,
resource_email_address,
show_meeting_details,
state,
type
FROM ovh.email_exchange.service_resource_accounts
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND resource_email_address = '{{ resource_email_address }}' -- required
;

list

List resource accounts. Returns the email addresses of the room and equipment resource accounts. Filter them by resourceEmailAddress or company.

SELECT
task_pending_id,
display_name,
add_organizer_to_subject,
allow_conflict,
booking_window,
capacity,
company,
creation_date,
delete_comments,
delete_subject,
location,
maximum_duration,
resource_email_address,
show_meeting_details,
state,
type
FROM ovh.email_exchange.service_resource_accounts
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND company = '{{ company }}'
AND resource_email_address = '{{ resource_email_address }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a resource account. Creates a room or equipment resource account from its resourceEmailAddress and capacity, and returns the task.

INSERT INTO ovh.email_exchange.service_resource_accounts (
add_organizer_to_subject,
allow_conflict,
booking_window,
capacity,
company,
delete_comments,
delete_subject,
display_name,
location,
maximum_duration,
resource_email_address,
show_meeting_details,
type,
exchange_service,
organization_name
)
SELECT 
{{ add_organizer_to_subject }},
{{ allow_conflict }},
{{ booking_window }},
{{ capacity }} /* required */,
'{{ company }}',
{{ delete_comments }},
{{ delete_subject }},
'{{ display_name }}',
'{{ location }}',
{{ maximum_duration }},
'{{ resource_email_address }}' /* required */,
'{{ show_meeting_details }}',
'{{ type }}' /* required */,
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_resource_accounts
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_resource_accounts resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_resource_accounts resource.
  - name: add_organizer_to_subject
    value: {{ add_organizer_to_subject }}
    description: |
      meeting organizer's name is used as the subject of the meeting request
  - name: allow_conflict
    value: {{ allow_conflict }}
    description: |
      resource can be scheduled by more than one person during the same time period
  - name: booking_window
    value: {{ booking_window }}
    description: |
      maximum number of days in advance that the resource can be reserved
  - name: capacity
    value: {{ capacity }}
    description: |
      number of the same equipment or capacity of a room
  - name: company
    value: "{{ company }}"
    description: |
      Company name
  - name: delete_comments
    value: {{ delete_comments }}
    description: |
      remove any text in the message body of incoming meeting requests on resourceAccount
  - name: delete_subject
    value: {{ delete_subject }}
    description: |
      remove email subject of incoming meeting requests on resourceAccount
  - name: display_name
    value: "{{ display_name }}"
    description: |
      resource account display name
  - name: location
    value: "{{ location }}"
    description: |
      resource location
  - name: maximum_duration
    value: {{ maximum_duration }}
    description: |
      maximum duration in minutes for meeting requests
  - name: resource_email_address
    value: "{{ resource_email_address }}"
    description: |
      resource address
  - name: show_meeting_details
    value: "{{ show_meeting_details }}"
    description: |
      granted right on a calendar of that resourceAccount
    valid_values: ['availabilityOnly', 'limitedDetails', 'reviewer']
  - name: type
    value: "{{ type }}"
    description: |
      type of your reservation
    valid_values: ['equipment', 'room']

UPDATE examples

update

Update a resource account. Updates the display name, capacity, location and booking settings of the resource account, such as allowConflict, bookingWindow or maximumDuration.

UPDATE ovh.email_exchange.service_resource_accounts
SET 
add_organizer_to_subject = {{ add_organizer_to_subject }},
allow_conflict = {{ allow_conflict }},
booking_window = {{ booking_window }},
capacity = {{ capacity }},
company = '{{ company }}',
delete_comments = {{ delete_comments }},
delete_subject = {{ delete_subject }},
display_name = '{{ display_name }}',
location = '{{ location }}',
maximum_duration = {{ maximum_duration }},
resource_email_address = '{{ resource_email_address }}',
show_meeting_details = '{{ show_meeting_details }}'
WHERE 
exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND resource_email_address = '{{ resource_email_address }}' --required;

DELETE examples

delete

Delete a resource account. Deletes the resource account (room or equipment) and its delegates, and returns the task.

DELETE FROM ovh.email_exchange.service_resource_accounts
WHERE exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND resource_email_address = '{{ resource_email_address }}' --required
;