task_contact_changes
Creates, updates, deletes, gets or lists a task_contact_changes resource.
Overview​
| Name | task_contact_changes |
| Type | Resource |
| Id | ovh.me.task_contact_changes |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | |
asking_account | string | Account who asked the contact change (wire: askingAccount) |
contact_types | array | Contacts to be changed (wire: contactTypes) |
date_done | string (date-time) | Date at which the contact change has been finished (wire: dateDone) |
date_request | string (date-time) | Date at which the request has been made (wire: dateRequest) |
from_account | string | Account to change contact from (wire: fromAccount) |
service_domain | string | The service on which the task runs (wire: serviceDomain) |
state | string | Current state of the request (aborted, checkValidity, doing, done, error, expired, refused, todo, validatingByCustomers) |
to_account | string | Account to change contact to (wire: toAccount) |
Task running a contact change on a service
| Name | Datatype | Description |
|---|---|---|
id | integer | |
asking_account | string | Account who asked the contact change (wire: askingAccount) |
contact_types | array | Contacts to be changed (wire: contactTypes) |
date_done | string (date-time) | Date at which the contact change has been finished (wire: dateDone) |
date_request | string (date-time) | Date at which the request has been made (wire: dateRequest) |
from_account | string | Account to change contact from (wire: fromAccount) |
service_domain | string | The service on which the task runs (wire: serviceDomain) |
state | string | Current state of the request (aborted, checkValidity, doing, done, error, expired, refused, todo, validatingByCustomers) |
to_account | string | Account to change contact to (wire: toAccount) |
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 | asking_account, state, to_account, x_pagination_mode | List of service contact change tasks you are involved in | |
accept | exec | id, token | Accept this change request | |
refuse | exec | id, token | Refuse this change request | |
resend_email | exec | id | This call will send you a new email, containing a new token |
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 | |
asking_account | string | Filter the value of askingAccount property (like) (wire: askingAccount) |
state | string | Filter the value of state property (like) |
to_account | string | Filter the value of toAccount property (like) (wire: toAccount) |
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,
asking_account,
contact_types,
date_done,
date_request,
from_account,
service_domain,
state,
to_account
FROM ovh.me.task_contact_changes
WHERE id = '{{ id }}' -- required
;
List of service contact change tasks you are involved in
SELECT
id,
asking_account,
contact_types,
date_done,
date_request,
from_account,
service_domain,
state,
to_account
FROM ovh.me.task_contact_changes
WHERE asking_account = '{{ asking_account }}'
AND state = '{{ state }}'
AND to_account = '{{ to_account }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- accept
- refuse
- resend_email
Accept this change request
EXEC ovh.me.task_contact_changes.accept
@id='{{ id }}' --required
@@json=
'{
"token": "{{ token }}"
}'
;
Refuse this change request
EXEC ovh.me.task_contact_changes.refuse
@id='{{ id }}' --required
@@json=
'{
"token": "{{ token }}"
}'
;
This call will send you a new email, containing a new token
EXEC ovh.me.task_contact_changes.resend_email
@id='{{ id }}' --required
;