List Criteria Fields For Layout Rules

GET {{baseUrl}}/api/v1/layouts/:layout_id/layoutRules/criteriaFields?category=<String>

This API lists the fields that can be used in criteria of a specified module in layout 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

HEADERS

RESPONSES

status: OK

{"criteriaFields":[{"displayLabel":"Tickets","name":"tickets","fieldDetails":[{"availableConditions":[{"condition":"is","value":["${CUSTOM}"]},{"condition":"isn't","value":["${CUSTOM}"]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"accountId","fieldLabel":"Account Name","i18NLabel":"Account Name","type":"lookup"},{"availableConditions":[{"condition":"is","value":["${CUSTOM}"]},{"condition":"isn't","value":["${CUSTOM}"]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"contactId","fieldLabel":"Contact Name","i18NLabel":"Contact Name","type":"lookup"},{"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 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":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"productId","fieldLabel":"Product Name","i18NLabel":"Product Name","type":"lookup"},{"availableConditions":[{"condition":"is","value":["${CURRENTTIME}","${CUSTOM}"]},{"condition":"isn't","value":["${CURRENTTIME}","${CUSTOM}"]},{"condition":"is after","value":["${CURRENTTIME}","${CUSTOM}"]},{"condition":"is before","value":["${CURRENTTIME}","${CUSTOM}"]},{"condition":"between","value":[["${CURRENTTIME}","${CUSTOM}"],["${CURRENTTIME}","${CUSTOM}"]]},{"condition":"not between","value":[["${CURRENTTIME}","${CUSTOM}"],["${CURRENTTIME}","${CUSTOM}"]]},{"condition":"is empty","value":["${EMPTY}"]},{"condition":"is not empty","value":["${NOTEMPTY}"]}],"fieldName":"dueDate","fieldLabel":"Due Date","i18NLabel":"Due Date","type":"dateTime"},{"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":"priority","fieldLabel":"Priority","i18NLabel":"Priority","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":"channel","fieldLabel":"Mode","i18NLabel":"Mode","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"}]}]}