This page documents the value representations of your self-defined project-specific fields, called Custom Fields, which you have on resources and data types that you have customized using Types.
These Custom Fields can be set or unset
- with the resource or object draft during creation of a customizable data type, or
- with Set CustomField update actions provided for each customizable data type.
Find the documentation for the drafts and the update actions in the respective API reference docs for the customized resource or data type.
To get notified when the Custom Fields on a resource are updated, create a ChangeSubscription that subscribes to changes on that resource (for example, to
When using Custom Fields with GraphQL API mutations, you must stringify all values in the
"value" : "\"A string value\"".
value field exists only in the GraphQL API, and not in the HTTP API.
JSON object containing name-value pairs with
- name being the
nameof the Custom Field as defined in the respective FieldDefinition and
- value being a CustomFieldValue compliant to the respective FieldType.
Find below an example FieldContainer with CustomFieldValues of several FieldTypes:
|Field type||Data type|
|CustomFieldEnumType||String. Must be a |
|CustomFieldLocalizedEnumType||String. Must be a |
|CustomFieldSetType||JSON array without duplicates consisting of CustomFieldValues of a single FieldType. For example, a Custom Field of CustomFieldSetType of CustomFieldDateType takes a JSON array of mutually different Dates for its value. The order of items in the array is not fixed. For more examples, see the example FieldContainer.|