license_office_news

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

Overview

Name	license_office_news
Type	Resource
Id	ovh.order.license_office_news

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

list

An order

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	duration	gift_code, office_business_quantity, office_pro_plus_quantity	Get prices and contracts information
list	select		gift_code, office_business_quantity, office_pro_plus_quantity, x_pagination_mode	Get allowed durations for 'new' option
create	insert	duration		Create order

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"}})
duration	string	Duration
gift_code	string	Gift code for office license (wire: giftCode)
office_business_quantity	integer	Number of prepaid office business license (wire: officeBusinessQuantity)
office_pro_plus_quantity	integer	Number of prepaid office pro plus license (wire: officeProPlusQuantity)
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 prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.license_office_news
WHERE duration = '{{ duration }}' -- required
AND gift_code = '{{ gift_code }}'
AND office_business_quantity = '{{ office_business_quantity }}'
AND office_pro_plus_quantity = '{{ office_pro_plus_quantity }}'
;

list

Get allowed durations for 'new' option

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.license_office_news
WHERE gift_code = '{{ gift_code }}'
AND office_business_quantity = '{{ office_business_quantity }}'
AND office_pro_plus_quantity = '{{ office_pro_plus_quantity }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create order

INSERT INTO ovh.order.license_office_news (
gift_code,
office_business_quantity,
office_pro_plus_quantity,
duration
)
SELECT 
'{{ gift_code }}',
{{ office_business_quantity }},
{{ office_pro_plus_quantity }},
'{{ duration }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: license_office_news
props:
  - name: duration
    value: "{{ duration }}"
    description: Required parameter for the license_office_news resource.
  - name: gift_code
    value: "{{ gift_code }}"
    description: |
      Gift code for office license
  - name: office_business_quantity
    value: {{ office_business_quantity }}
    description: |
      Number of prepaid office business license
  - name: office_pro_plus_quantity
    value: {{ office_pro_plus_quantity }}
    description: |
      Number of prepaid office pro plus license