Get MyForm
GET {{baseUrl}}/api/v1/myForm
This API fetches details of a layout, based on the profile of the current user. Status mappings and dependency mappings are also included
OAuth Scope
Desk.basic.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
layoutId | string | ID of the layout |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"modifiedTime":"2017-07-10T10:32:11.000Z","createdBy":"4000000009118","departmentId":"4000000007175","createdTime":"2017-07-01T07:36:04.000Z","modifiedBy":"4000000009118","id":"4000000007177","isDefaultLayout":true,"sections":[{"name":"Ticket Information","isCustomSection":false,"id":1,"fields":[{"displayLabel":"Department","apiName":"departmentId","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000353","type":"LookUp","maxLength":50,"isMandatory":true},{"displayLabel":"Contact Name","apiName":"contactId","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000357","type":"LookUp","maxLength":300,"isMandatory":true},{"displayLabel":"Account Name","apiName":"accountId","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000355","type":"LookUp","maxLength":300,"isMandatory":false},{"displayLabel":"Email","apiName":"email","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000359","type":"Email","maxLength":120,"isMandatory":false},{"displayLabel":"Phone","apiName":"phone","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000361","type":"Phone","maxLength":120,"isMandatory":false},{"displayLabel":"Sub Category","allowedValues":["Sub General","Sub Defects"],"apiName":"subCategory","isReadOnly":false,"isCustomField":false,"defaultValue":"Sub General","isEncryptedField":false,"id":"4000000000423","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Category","allowedValues":["General","Defects","ManojKumar"],"apiName":"category","isCustomField":false,"isReadOnly":false,"defaultValue":"General","isEncryptedField":false,"id":"4000000000421","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Subject","apiName":"subject","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000363","type":"Text","maxLength":255,"isMandatory":true},{"displayLabel":"Description","apiName":"description","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000365","type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Status","allowedValues":["Open","Open_july","Open_newDept","On Hold","Escalated","Closed1","Closed","newDeptClosed","julyDeptClosed","julyDeptClosed1"],"apiName":"status","isCustomField":false,"isReadOnly":false,"restoreOnReplyValues":["Open_july","newDeptClosed","Open_newDept","Escalated","On Hold","Closed","Closed1","julyDeptClosed","julyDeptClosed1","Open"],"defaultValue":"Open","isEncryptedField":false,"id":"4000000000367","type":"Picklist","maxLength":120,"isMandatory":true},{"displayLabel":"Case Owner","apiName":"assigneeId","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000371","type":"LookUp","maxLength":120,"isMandatory":false},{"displayLabel":"Product Name","apiName":"productId","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000369","type":"LookUp","maxLength":120,"isMandatory":false}]},{"name":"Additional Information","isCustomSection":false,"id":2,"fields":[{"displayLabel":"Due Date","apiName":"dueDate","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000405","type":"DateTime","maxLength":300,"isMandatory":false},{"displayLabel":"Priority","allowedValues":["-None-","High","Medium","Low"],"apiName":"priority","isReadOnly":false,"isCustomField":false,"defaultValue":"-None-","isEncryptedField":false,"id":"4000000000407","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Mode","allowedValues":["Phone","Email","Web","Twitter","Facebook","Chat","Forums","Feedback Widget"],"apiName":"channel","isReadOnly":false,"isCustomField":false,"defaultValue":"Phone","isEncryptedField":false,"id":"4000000000409","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Is Overdue","apiName":"Is Overdue","isReadOnly":false,"isCustomField":false,"defaultValue":"true","isEncryptedField":false,"id":"4000000000411","type":"Boolean","maxLength":50,"isMandatory":false},{"displayLabel":"Is Escalated","apiName":"Is Escalated","isReadOnly":false,"isCustomField":false,"defaultValue":"true","isEncryptedField":false,"id":"4000000000413","type":"Boolean","maxLength":50,"isMandatory":false},{"displayLabel":"Classification","allowedValues":["-None-","Question","Problem","Feature","Others"],"apiName":"classification","isReadOnly":false,"isCustomField":false,"defaultValue":"-None-","isEncryptedField":false,"id":"4000000000415","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Resolution","apiName":"resolution","isReadOnly":false,"isCustomField":false,"isEncryptedField":false,"id":"4000000000417","type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Sample TextArea","apiName":"cf_sample_textarea","isCustomField":true,"toolTipType":"placeHolder","isEncryptedField":false,"toolTip":"Sample Field","id":"4000000000447","isSystemMandatory":false,"isRemovable":false,"type":"Textarea","maxLength":1000000,"isMandatory":false}]}],"layoutName":"Default Ticket Layout"}