Field Metadata REST API
Use this high-level API to create, update, or delete fields of specified objects. For ease of use, only required fields are mandatory, defaults are assumed for all other fields, and identifiers (or full identifiers for certain related records are used instead of the UUID.
The Field Metadata REST API calls Field Metadata Groovy API methods to avoid duplicating logic, validations, and so on. For more information, see Field Metadata Groovy API.
REST API Endpoints Summary
Action
Method
URL
Input
Output
Parameters
POST
/v2/<object_full_identifier>/fields
JSON representation of an array of Map <Field, value> that contains field data.
JSON representation of the fields created and related to the specified object.
PUT
/v2/<object_full_identifier>/fields
JSON representation of an array of Map <Field, value>, including full identifiers for each field to update.
JSON representation of the fields created and related to the specified object.
DELETE
/v2/<object_full_identifier>/fields
HTTP Status Code 200 if all records are successfully deleted.
identifiers
uuids
For more information:
Was this helpful?