contact_fields
Creates, updates, deletes, gets or lists a contact_fields resource.
Overview​
| Name | contact_fields |
| Type | Resource |
| Id | ovh.me.contact_fields |
Fields​
The following fields are returned by SELECT queries:
- list
Extras information about a field
| Name | Datatype | Description |
|---|---|---|
field_name | string | Name of the field concerned by restrictions (wire: fieldName) |
mandatory | boolean | Indicates if the field is mandatory when editing |
read_only | boolean | Indicates if the field can't be edited (wire: readOnly) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | contact_id | Get mandatory/read-only information about the fields of a contact |
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"}}) |
contact_id | integer | Contact ID (wire: contactId) |
SELECT examples​
- list
Get mandatory/read-only information about the fields of a contact
SELECT
field_name,
mandatory,
read_only
FROM ovh.me.contact_fields
WHERE contact_id = '{{ contact_id }}' -- required
;