List Detail Field Library
Changed onRequest
- Base URLhttps://api.mitti.com
- AuthHTTP bearer
Query parameters
Search on a field's name
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.
Search on a field's ids
Filter by creator user IDs
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
Filter by targets that the field applies to
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.
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
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).
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.
Optional. The direction to sort fields in.
Response
A successful response.
Changes
- warning
added the new
DOMAIN_DOCUMENTSenum value to the//////response property for the response status
- warning