Skip to main content

agreements_contracts

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

Overview​

Nameagreements_contracts
TypeResource
Idovh.me.agreements_contracts

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
namestringName of of the contract
activebooleanIs this contract currently active or not ?
datestring (date)Date the contract was created on
pdfstringURL you can download the contract at
textstringFull text of the contract

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectidGet this object properties

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.

NameDatatypeDescription
api_hoststringThe 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"}})
idintegerId of the contract

SELECT examples​

Get this object properties

SELECT
name,
active,
date,
pdf,
text
FROM ovh.me.agreements_contracts
WHERE id = '{{ id }}' -- required
;