Standard Layout Format

GET {{baseUrl}}/api/v1/layouts/standardLayoutFormat?module=<String>

This Api provides the standrd layout format for the given module with organisations fields that can be used for create layout

OAuth Scope

• Desk.basic.READ

Request Params

HEADERS

RESPONSES

status: OK

{"data":[{"name":"Case Information","id":1,"fields":[{"displayLabel":"Department","isCustomField":false,"name":"departmentId","id":"4000000000556","isSystemMandatory":false,"isRemovable":false,"type":"LookUp","maxLength":50,"isMandatory":true},{"displayLabel":"Account Name","isCustomField":false,"name":"accountId","id":"4000000000558","isSystemMandatory":false,"isRemovable":true,"type":"LookUp","maxLength":300,"isMandatory":false},{"displayLabel":"Contact Name","isCustomField":false,"name":"contactId","id":"4000000000560","isSystemMandatory":true,"isRemovable":false,"type":"LookUp","maxLength":300,"isMandatory":true},{"displayLabel":"Email","isCustomField":false,"name":"email","id":"4000000000562","isSystemMandatory":false,"isRemovable":false,"type":"Email","maxLength":120,"isMandatory":false},{"displayLabel":"Phone","isCustomField":false,"name":"phone","id":"4000000000564","isSystemMandatory":false,"isRemovable":true,"type":"Phone","maxLength":120,"isMandatory":false},{"displayLabel":"Subject","isCustomField":false,"name":"subject","id":"4000000000566","isSystemMandatory":true,"isRemovable":false,"type":"Text","maxLength":255,"isMandatory":true},{"displayLabel":"Description","isCustomField":false,"name":"description","id":"4000000000568","isSystemMandatory":false,"isRemovable":false,"type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Status","allowedValues":["Open","On Hold","Escalated","Closed"],"isCustomField":false,"defaultValue":"Open","isSystemMandatory":true,"type":"Picklist","restoreOnReplyValues":["Open","On Hold","Escalated","Closed"],"name":"status","sortBy":"userDefined","id":"4000000000570","isRemovable":false,"maxLength":120,"isMandatory":true},{"displayLabel":"Product Name","isCustomField":false,"name":"productId","id":"4000000000572","isSystemMandatory":false,"isRemovable":true,"type":"LookUp","maxLength":120,"isMandatory":false},{"displayLabel":"Ticket Owner","isCustomField":false,"name":"assigneeId","id":"4000000000574","isSystemMandatory":false,"isRemovable":false,"type":"LookUp","maxLength":120,"isMandatory":false}]},{"name":"Additional Information","id":2,"fields":[{"displayLabel":"Due Date","isCustomField":false,"name":"dueDate","id":"4000000000610","isSystemMandatory":false,"isRemovable":false,"type":"DateTime","maxLength":300,"isMandatory":false},{"displayLabel":"Priority","allowedValues":["-None-","High","Medium","Low"],"isCustomField":false,"defaultValue":"-None-","name":"priority","sortBy":"userDefined","id":"4000000000614","isSystemMandatory":false,"isRemovable":false,"type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Channel","allowedValues":["Phone","Email","Web","Twitter","Facebook","Chat","Forums","Feedback Widget"],"isCustomField":false,"defaultValue":"Phone","name":"channel","sortBy":"userDefined","id":"4000000000616","isSystemMandatory":false,"isRemovable":false,"type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Classification","allowedValues":["-None-","Question","Problem","Feature","Others"],"isCustomField":false,"defaultValue":"-None-","name":"classification","sortBy":"userDefined","id":"4000000000622","isSystemMandatory":false,"isRemovable":true,"type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Resolution","isCustomField":false,"name":"resolution","id":"4000000000624","isSystemMandatory":false,"isRemovable":false,"type":"Textarea","maxLength":1000000,"isMandatory":false}]},{"name":"Category Information","id":3,"fields":[]},{"name":"Related List Section","id":4,"fields":[]}]}