Skip to content

Properties

applicable_forstring

The unique identifier of the applicable

applicable_instring

The context in which the field is applicable

Possible values:
collectionworkspaceticket
created_atstring · date-time

The date and time of the field's creation

descriptionstring

The field's description

entity_idstring

The unique identifier for the entity the field belongs to

entity_typestring

The entity type the field belongs to

Possible values:
ticket_typeticketcollectionuser
etagstring

The unique identifier for the specific version of the resource.

formatstring

The field's format.

idstring

The field's unique identifier

is_hiddenboolean

Whether the field is hidden

is_requiredboolean

Whether the field is required

is_uniqueboolean

Whether the field is unique

is_user_definedboolean

Whether the field is user defined

labelstring

The field's label

namestring

The field's name. This is the name of the property in the entity.

optionsobject[]

The field's options

descriptionstring

The option's description

is_hiddenboolean

Whether the option is hidden

labelstring

The option's label

valuestring

The option's value

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the field

Possible values:
activearchived
ticket_typestring

The ticket_type's unique identifier

typestring

The field's type. If no clear mapping exists, then raw value is returned.

Possible values:
stringtextrich_textnumberbooleandatedatetimetimeenumarrayfile
updated_atstring · date-time

The date and time of the field's last update