DatoCMS REST API client v0.6.2 DatoCMS.RESTClient.Field View Source

Link to this section Summary

Functions

Calls POST /item-types/{(%2Fschemata%2Fitem_type%23%2Fdefinitions%2Fitem_type%2Fdefinitions%2Fidentity)}/fields

Calls DELETE /fields/{(%2Fschemata%2Ffield%23%2Fdefinitions%2Ffield%2Fdefinitions%2Fidentity)}

Calls GET /fields/{(%2Fschemata%2Ffield%23%2Fdefinitions%2Ffield%2Fdefinitions%2Fidentity)}

Calls GET /item-types/{(%2Fschemata%2Fitem_type%23%2Fdefinitions%2Fitem_type%2Fdefinitions%2Fidentity)}/fields

Calls PUT /fields/{(%2Fschemata%2Ffield%23%2Fdefinitions%2Ffield%2Fdefinitions%2Fidentity)}

Link to this section Functions

Calls POST /item-types/{(%2Fschemata%2Fitem_type%23%2Fdefinitions%2Fitem_type%2Fdefinitions%2Fidentity)}/fields

params is JSON encoded and passed as the request body.

params Schema

{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"description":"JSON API attributes","properties":{"api_key":{"description":"Field API key","example":"title","type":"string"},"appeareance":{"description":"Field appeareance","example":{"type":"plain"},"type":["null","object"]},"field_type":{"description":"Type of input","example":"string","type":"string"},"hint":{"description":"Field hint","example":"This field will be used as post title","type":["string","null"]},"label":{"description":"The label of the field","example":"Title","type":"string"},"localized":{"description":"Whether the field needs to be multilanguage or not","type":"boolean"},"position":{"description":"Ordering index","example":1,"type":"integer"},"validators":{"description":"Optional field validations","example":{"required":{}},"type":"object"}},"required":["label","field_type","api_key","localized","validators","appeareance","position","hint"],"type":"object"},"type":{"description":"JSON API type field","example":"field","pattern":"^field$","type":["string"]}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}

Calls DELETE /fields/{(%2Fschemata%2Ffield%23%2Fdefinitions%2Ffield%2Fdefinitions%2Fidentity)}

Calls GET /fields/{(%2Fschemata%2Ffield%23%2Fdefinitions%2Ffield%2Fdefinitions%2Fidentity)}

Calls GET /item-types/{(%2Fschemata%2Fitem_type%23%2Fdefinitions%2Fitem_type%2Fdefinitions%2Fidentity)}/fields

Calls PUT /fields/{(%2Fschemata%2Ffield%23%2Fdefinitions%2Ffield%2Fdefinitions%2Fidentity)}

params is JSON encoded and passed as the request body.

params Schema

{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"api_key":{"description":"Field API key","example":"title","type":"string"},"appeareance":{"description":"Field appeareance","example":{"type":"plain"},"type":["null","object"]},"hint":{"description":"Field hint","example":"This field will be used as post title","type":["string","null"]},"label":{"description":"The label of the field","example":"Title","type":"string"},"localized":{"description":"Whether the field needs to be multilanguage or not","type":"boolean"},"position":{"description":"Ordering index","example":1,"type":"integer"},"validators":{"description":"Optional field validations","example":{"required":{}},"type":"object"}},"type":"object"},"id":{"description":"ID of field","example":"124","type":"string"},"type":{"description":"JSON API type field","example":"field","pattern":"^field$","type":["string"]}},"required":["type","id","attributes"],"type":"object"}},"required":["data"],"type":"object"}