migration_contracts

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

Overview

Name	migration_contracts
Type	Resource
Id	ovh.me.migration_contracts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID
name	string	Name
active	boolean	Status
date	string (date)	Date
pdf	string	PDF URL
text	string	Text of the contract

list

contract

Name	Datatype	Description
id	integer	ID
name	string	Name
active	boolean	Status
date	string (date)	Date
pdf	string	PDF URL
text	string	Text of the contract

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	contract_id, migration_id		Retrieve detail about a contract for a billing country migration (Beta version)
list	select	migration_id	x_pagination_mode	Retrieve all contracts for a billing country migration (Beta version)
accept	exec	contractId, migrationId		Accept contract (Beta version)

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"}})
contractId	integer	Contract ID
contract_id	integer	Contract ID (wire: contractId)
migrationId	integer	Migration ID
migration_id	integer	Migration ID (wire: migrationId)
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

Retrieve detail about a contract for a billing country migration (Beta version)

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

list

Retrieve all contracts for a billing country migration (Beta version)

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

Lifecycle Methods

EXEC variables use wire (API) names.

accept

Accept contract (Beta version)

EXEC ovh.me.migration_contracts.accept 
@contractId='{{ contractId }}' --required, 
@migrationId='{{ migrationId }}' --required
;