Get Layout Rules for department or layout
GET {{baseUrl}}/api/v1/layoutRules
This API lists all the rules configured for a department/layout.
OAuth Scope
Desk.settings.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
departmentId | string | Get the rules of the department | |
layoutId | string | Get the rules of the layout | |
module | string | Name of the module for which you want to fetch the layout rules. Allowed values are tickets, contacts, accounts, tasks, timeEntry, contracts, products, calls, events | |
activeLayouts | string | Get the rules for active layouts | |
activeRules | string | Get the rules that are active in the layout | |
executeInHelpCentre | string | Get the rules that can be executed in help centre | |
from | string | Index number, starting from which the rules must be fetched | |
limit | string | Number of rules to be fetched. Default is 50 | |
searchString | string | Get the rules that have this search term | |
include | string | Additional information related to the rules. Values allowed are: creator and modifier. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"fieldConditions":[{"name":"condition 1","pattern":"(1and2)","conditions":[{"condition":"is","fieldName":"email","value":["carol@zylker.com"]},{"condition":"is","fieldName":"phone","value":["9993292892"]}],"actions":{"showSections":["Additional Information"],"showFields":["subject"],"setMandatoryFields":["priority"]}}],"modifiedTime":"2018-09-14T01:08:42.000Z","fieldName":"email","description":"Rule 1 for layout","systemGenerated":false,"layoutId":"4000000007723","executeInHelpCentre":false,"createdBy":"4000000015963","name":"Rule 1","createdTime":"2018-09-14T01:07:22.000Z","modifiedBy":"4000000015963","id":"4000000020001","status":"active"},{"fieldConditions":[{"name":"condition 2","pattern":"(1or2)","conditions":[{"condition":"is","fieldName":"phone","value":["9993292892"]},{"condition":"is","fieldName":"email","value":["carol@zylker.com"]}],"actions":{"showSections":["Additional Information"],"showFields":["subject"],"setMandatoryFields":["priority"]}}],"modifiedTime":"2018-09-14T01:08:42.000Z","fieldName":"phone","description":"Rule 2 for layout","systemGenerated":false,"layoutId":"4000000007723","executeInHelpCentre":false,"createdBy":"4000000015963","name":"Rule 2","createdTime":"2018-09-14T01:07:22.000Z","modifiedBy":"4000000015963","id":"4000000021001","status":"active"}]}