agreements
Creates, updates, deletes, gets or lists an agreements resource.
Overview​
| Name | agreements |
| Type | Resource |
| Id | ovh.me.agreements |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Id of the contract |
contract_id | integer | Id of the agreed contract (wire: contractId) |
agreed | string | State of the agreement (ko, obsolete, ok, todo) |
date | string (date-time) | Date the agreed contract was effective |
Contract agreement
| Name | Datatype | Description |
|---|---|---|
id | integer | Id of the contract |
contract_id | integer | Id of the agreed contract (wire: contractId) |
agreed | string | State of the agreement (ko, obsolete, ok, todo) |
date | string (date-time) | Date the agreed contract was effective |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id | Get this object properties | |
list | select | agreed, contract_id, x_pagination_mode | List of contracts signed between you and OVH | |
accept | exec | id | Accept this contract |
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"}}) |
id | integer | Id of the contract |
agreed | string | Filter the value of agreed property (like) |
contract_id | integer | Filter the value of contractId property (like) (wire: contractId) |
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
- list
Get this object properties
SELECT
id,
contract_id,
agreed,
date
FROM ovh.me.agreements
WHERE id = '{{ id }}' -- required
;
List of contracts signed between you and OVH
SELECT
id,
contract_id,
agreed,
date
FROM ovh.me.agreements
WHERE agreed = '{{ agreed }}'
AND contract_id = '{{ contract_id }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- accept
Accept this contract
EXEC ovh.me.agreements.accept
@id='{{ id }}' --required
;