Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Investigations

List Detail Field Library

get/incidents/v1/field-library

Query parameters

criteria.filter.searchstring

Search on a field's name

criteria.filter.category'FIELD_CATEGORY_UNSPECIFIED' | 'FIELD_CATEGORY_SYSTEM_FIELD' | 'FIELD_CATEGORY_CUSTOM_FIELD'

Search on a field's category

  • FIELD_CATEGORY_UNSPECIFIED: Field category Unspecified.
  • FIELD_CATEGORY_SYSTEM_FIELD: Field category pre-defined.
  • FIELD_CATEGORY_CUSTOM_FIELD: Field category custom.
criteria.filter.field_idsstring[]

Search on a field's ids

criteria.filter.created_bystring[]

Filter by creator user IDs

criteria.filter.field_typesstring[]

Filter by field value types

  • FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified.
  • FIELD_VALUE_TYPE_STRING: Field value type string.
  • FIELD_VALUE_TYPE_MONEY: Field value type money.
  • FIELD_VALUE_TYPE_TIMESTAMP: Field value type timestamp.
  • FIELD_VALUE_TYPE_USER_ID: Field value type user ID.
  • FIELD_VALUE_TYPE_SELECT: Field value type select
  • FIELD_VALUE_TYPE_TEMPLATE_ID: Field value type template ID.
  • FIELD_VALUE_TYPE_MULTI_SELECT: Field value type multi-select
  • FIELD_VALUE_TYPE_SITE: Field value type site
  • FIELD_VALUE_TYPE_MULTI_SITE: Field value type multi-site
  • FIELD_VALUE_TYPE_INTEGER: Field value type integer
  • FIELD_VALUE_TYPE_ADDRESS: Field value type address.
  • FIELD_VALUE_TYPE_TIMEZONE: Field value type timezone
  • FIELD_VALUE_TYPE_CONTACT_DETAILS: Field value type contact details
criteria.filter.applies_tostring[]

Filter by targets that the field applies to

criteria.filter.state'FIELD_STATE_UNSPECIFIED' | 'FIELD_STATE_ACTIVE' | 'FIELD_STATE_DELETED' | 'FIELD_STATE_ARCHIVED'

Optional. Filter by field state. When not set, defaults to FIELD_STATE_UNSPECIFIED.

  • FIELD_STATE_UNSPECIFIED: Field state unspecified.
  • FIELD_STATE_ACTIVE: Field is active.
  • FIELD_STATE_DELETED: Field is deleted.
  • FIELD_STATE_ARCHIVED: Field is archived and no longer active, but not deleted. Cannot be applied to system fields.
criteria.filter.mapping_metadata[string]string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

criteria.option_sort'FIELD_OPTION_SORT_UNSPECIFIED' | 'FIELD_OPTION_SORT_ALPHABETICAL' | 'FIELD_OPTION_SORT_CUSTOM'

Optional. Defines sorting for field option labels on returned field objects.

  • FIELD_OPTION_SORT_UNSPECIFIED: Unspecified sort order.
  • FIELD_OPTION_SORT_ALPHABETICAL: Alphabetical sort order (default).
  • FIELD_OPTION_SORT_CUSTOM: Custom sort order (as defined by the user).
criteria.sort_field'SORT_FIELD_UNSPECIFIED' | 'SORT_FIELD_NAME' | 'SORT_FIELD_CREATED_AT'

Optional. The field to use for sorting.

  • SORT_FIELD_UNSPECIFIED: SORT_FIELD_UNSPECIFIED returns the default sort order.
  • SORT_FIELD_NAME: SORT_FIELD_NAME sorts fields by name.
  • SORT_FIELD_CREATED_AT: SORT_FIELD_CREATED_AT sorts fields by creation time.
criteria.sort_direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

Optional. The direction to sort fields in.

Response

A successful response.

next_page_tokenstring

the token for the next page of results