POST /api/v2/it_asset_management/asset_types/{asset_type_id}/fields

Creates an asset field for an individual asset type.

Allowed For

Admins

Servers

https://{subdomain}.{domain}.com

Path parameters

Name	Type	Required	Description
`asset_type_id`	String	Yes	The id of the asset type

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`field`	Object	No
`field.readonly`	Boolean	No	If true, the field value cannot be set or updated by API consumers. Currently only applies to roll-up summary fields, where the value is computed automatically.
`field.description`	String	No	User-defined description of this field's purpose
`field.regexp_for_validation`	String	No	Regular expression field only. The validation pattern for a field value to be deemed valid
`field.url`	String	No	The URL for this resource
`field.properties`	Object	No	A set of field-specific properties. For the standard::name field, this includes autonumbering and uniqueness settings (which can't be used together). For currency fields, this includes the allowed currency code. For parent fields, includes the `cascade_permissions_enabled` setting. For roll-up summary fields, includes the aggregation configuration.
`field.properties.rollup_aggregated_field_title`	String	No	Roll-up fields only. Read-only. The display title of the aggregated child field
`field.properties.allowed_currencies[]`	Array	No	An array containing exactly one ISO 4217 currency code (for example, ["USD"]). The currency code can't be changed after the field is created.
`field.properties.rollup_aggregation_type`	String	No	Roll-up fields only. The aggregation operation to apply to child records. One of: "COUNT", "SUM", "MIN", "MAX" Valid values: `"MIN"` `"MAX"` `"COUNT"` `"SUM"`
`field.properties.rollup_aggregated_field`	String	No	Roll-up fields only. The key of the field on the child object to aggregate. Not required for COUNT
`field.properties.is_unique`	Boolean	No	Turns uniqueness on or off
`field.properties.autoincrement_next_sequence`	Integer	No	The next number in the autonumbering sequence. It can't be negative or less than the current autonumbering value
`field.properties.cascade_permissions_enabled`	Boolean	No	Parent fields only. If true, permissions for the child object's records cascade from the parent record. When enabled, agents must provide a parent record context to list or search child records. Only one parent field per child object can have this setting enabled. Default: false.
`field.properties.autoincrement_prefix`	String	No	A prefix to autogenerated numbers that can't exceed 30 characters
`field.properties.rollup_filter_criteria`	Object	No	Roll-up fields only. Optional filter conditions (using `all`/`any` arrays) to restrict which child records are included in the aggregation. Uses the same DSL as lookup relationship filters
`field.properties.rollup_child_object`	String	No	Roll-up fields only. The Zendesk resource name (ZRN) of the child object whose records are aggregated. Example: "zen:custom_object:order_item". The child object must have a parent-child relationship with this field's object
`field.properties.autoincrement_enabled`	Boolean	No	Turns autonumbering on or off
`field.properties.autoincrement_padding`	Integer	No	Sets the number of digits for autogenerated numbers. Valid values are 0-9
`field.required`	Boolean	No	If true, the field must have a value when creating or updating custom object records.
`field.custom_field_options[]`	Array	No	Required and presented for a custom field of type "dropdown". Each option is represented by an object with a `name` and `value` property
`field.custom_field_options[].id`	Integer	No	Automatically assigned upon creation
`field.custom_field_options[].allow_solving`	Boolean	No	Whether selecting this option allows solving the ticket when the field is required to solve
`field.custom_field_options[].name`	String	Yes	Name of the dropdown option
`field.custom_field_options[].url`	String	No	URL of the dropdown option
`field.custom_field_options[].raw_name`	String	No	Raw name of the dropdown option
`field.custom_field_options[].value`	String	Yes	Value of the dropdown option
`field.custom_field_options[].position`	Integer	No	Position of the dropdown option
`field.position`	Integer	No	Ordering of the field relative to other fields
`field.tag`	String	No	Optional for custom field of type "checkbox"; not presented otherwise.
`field.updated_at`	String	No	The time of the last update of the field
`field.relationship_target_type`	String	No	A representation of what type of object the field references. For lookup fields, options are "zen:user", "zen:organization", "zen:ticket", "zen:article", "zen:brand", and "zen:custom_object:{key}" where key is a custom object key. For example "zen:custom_object:apartment". For parent fields, valid options are "zen:user", "zen:organization", "zen:ticket", and "zen:custom_object:{key}". Cannot be changed after creation.
`field.id`	Integer	No	Automatically assigned upon creation
`field.relationship_filter`	Object	No	A filter definition that allows your autocomplete to filter down results
`field.raw_description`	String	No	The dynamic content placeholder, if present, or the `description` value, if not. See Dynamic Content Items
`field.active`	Boolean	No	If true, this field is available for use
`field.key`	String	Yes	A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders. The key must consist of only letters, numbers, and underscores. It can't be only numbers
`field.raw_title`	String	No	The dynamic content placeholder, if present, or the `title` value, if not. See Dynamic Content Items
`field.system`	Boolean	No	If true, only active and position values of this field can be changed
`field.title`	String	Yes	The title of the custom field
`field.type`	String	Yes	The custom field type: "checkbox", "currency", "date", "decimal", "dropdown", "integer", "lookup", "multiselect", "parent" (custom objects only), "regexp", "text", or "textarea"
`field.created_at`	String	No	The time the field was created

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.