List Criteria Fields For Layout Validation Rules
GET {{baseUrl}}/api/v1/layouts/:layout_id/validationRules/criteriaFields?category=<String>
This API lists the fields that can be used in criteria of a specified module in validation rules. Available pre-defined values may contain ${EMPTY}, ${NOTEMPTY}, ${OPEN}, ${CLOSED}, ${CURRENTTIME}. Available types are Text, Date, DateTime, Text, Boolean and Arithmetic.
OAuth Scope
Desk.settings.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
category | string | Category for getting the field criteria for primary or secondary fields |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"criteriaFields":[{"displayLabel":"Tickets","name":"tickets","fieldDetails":[{"availableConditions":[{"condition":"is","value":["${CUSTOM}"]},{"condition":"isn't","value":["${CUSTOM}"]},{"condition":"starts with","value":["${CUSTOM}"]},{"condition":"contains","value":["${CUSTOM}"]},{"condition":"doesn't contain","value":["${CUSTOM}"]},{"condition":"ends with","value":["${CUSTOM}"]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"email","fieldLabel":"Email","i18NLabel":"Email","type":"text"},{"availableConditions":[{"condition":"is","value":["${CUSTOM}"]},{"condition":"isn't","value":["${CUSTOM}"]},{"condition":"starts with","value":["${CUSTOM}"]},{"condition":"contains","value":["${CUSTOM}"]},{"condition":"doesn't contain","value":["${CUSTOM}"]},{"condition":"ends with","value":["${CUSTOM}"]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"phone","fieldLabel":"Phone","i18NLabel":"Phone","type":"text"},{"availableConditions":[{"condition":"is","value":["${CUSTOM}"]},{"condition":"isn't","value":["${CUSTOM}"]},{"condition":"starts with","value":["${CUSTOM}"]},{"condition":"contains","value":["${CUSTOM}"]},{"condition":"doesn't contain","value":["${CUSTOM}"]},{"condition":"ends with","value":["${CUSTOM}"]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"subject","fieldLabel":"Subject","i18NLabel":"Subject","type":"text"},{"availableConditions":[{"condition":"is OPEN","value":["${OPEN}"]},{"condition":"is CLOSED","value":["${CLOSED}"]},{"condition":"is","value":["${CUSTOM}"]},{"condition":"isn't","value":["${CUSTOM}"]},{"condition":"starts with","value":["${CUSTOM}"]},{"condition":"contains","value":["${CUSTOM}"]},{"condition":"doesn't contain","value":["${CUSTOM}"]},{"condition":"ends with","value":["${CUSTOM}"]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"status","fieldLabel":"Status","i18NLabel":"Status","type":"text"},{"availableConditions":[{"condition":"is","value":["${CUSTOM}"]},{"condition":"isn't","value":["${CUSTOM}"]},{"condition":"starts with","value":["${CUSTOM}"]},{"condition":"contains","value":["${CUSTOM}"]},{"condition":"doesn't contain","value":["${CUSTOM}"]},{"condition":"ends with","value":["${CUSTOM}"]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"classification","fieldLabel":"Classification","i18NLabel":"Classification","type":"text"}]}]}