Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sSequence_number
String sDisplay_label
String sApi_name
String sModule
String sName
String sAction
String sId
String sHref
String sV_type
String sConnectedmodule
String sLinkingmodule
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "module" "Leads" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://domain.com/crm/v2.1/settings/related_lists" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "related_lists": [
// {
// "sequence_number": "1",
// "display_label": "Notes",
// "api_name": "Notes",
// "module": "Notes",
// "name": "Notes",
// "action": null,
// "id": "738964000000002730",
// "href": "Leads/{ENTITYID}/Notes",
// "type": "default"
// },
// {
// "sequence_number": "1",
// "display_label": "Lead Status History",
// "api_name": "Lead_Status_History",
// "module": "Lead_Status_History",
// "name": "Lead Status History",
// "action": "picklist_tracker",
// "id": "738964000001920298",
// "href": "Leads/{ENTITYID}/Lead_Status_History",
// "type": "default"
// },
// {
// "sequence_number": "2",
// "display_label": "Attachments",
// "api_name": "Attachments",
// "module": "Attachments",
// "name": "Attachments",
// "action": null,
// "id": "738964000000002724",
// "href": "Leads/{ENTITYID}/Attachments",
// "type": "default"
// },
// {
// "sequence_number": "3",
// "display_label": "Products",
// "api_name": "Products",
// "module": "Products",
// "name": "Products",
// "action": null,
// "id": "738964000000002726",
// "href": "Leads/{ENTITYID}/Products",
// "type": "default"
// },
// {
// "sequence_number": "4",
// "display_label": "Open Activities",
// "api_name": "Activities",
// "module": "Activities",
// "name": "Activities",
// "action": null,
// "id": "738964000000002722",
// "href": "Leads/{ENTITYID}/Activities",
// "type": "default"
// },
// {
// "sequence_number": "5",
// "display_label": "Closed Activities",
// "api_name": "Activities_History",
// "module": "Activities",
// "name": "Activities History",
// "action": null,
// "id": "738964000000002720",
// "href": "Leads/{ENTITYID}/Activities_History",
// "type": "default"
// },
// {
// "sequence_number": "6",
// "display_label": "Invited Meetings",
// "api_name": "Invited_Events",
// "module": "Events",
// "name": "Invited Events",
// "action": null,
// "id": "738964000000044001",
// "href": "Leads/{ENTITYID}/Invited_Events",
// "type": "default"
// },
// {
// "sequence_number": "7",
// "display_label": "Emails",
// "api_name": "Emails",
// "module": "Emails",
// "name": "Emails",
// "action": null,
// "id": "738964000000002728",
// "href": null,
// "type": "default"
// },
// {
// "sequence_number": "8",
// "display_label": "Campaigns",
// "api_name": "Campaigns",
// "module": "Campaigns",
// "name": "Campaigns",
// "action": null,
// "id": "738964000000023017",
// "href": "Leads/{ENTITYID}/Campaigns",
// "type": "default"
// },
// {
// "sequence_number": "9",
// "display_label": "Social",
// "api_name": "Social",
// "module": "Social",
// "name": "Social",
// "action": null,
// "id": "738964000000048003",
// "href": null,
// "type": "default"
// },
// {
// "sequence_number": "10",
// "display_label": "Checklists",
// "api_name": "CheckLists",
// "module": "CheckLists",
// "name": "CheckLists",
// "action": null,
// "id": "738964000000156005",
// "href": "Leads/{ENTITYID}/CheckLists",
// "type": "default"
// },
// {
// "sequence_number": "12",
// "display_label": "Deals",
// "api_name": "Deals8",
// "module": "Deals_X_Leads",
// "name": "Deals",
// "action": null,
// "id": "738964000001921504",
// "href": "Leads/{ENTITYID}/Deals8",
// "type": "multiselectlookup",
// "connectedmodule": "Potentials",
// "linkingmodule": "LinkingModule8"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Move 0 To i
Get ComSizeOfArray Of hoJResp "related_lists" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "related_lists[i].sequence_number" To sSequence_number
Get ComStringOf Of hoJResp "related_lists[i].display_label" To sDisplay_label
Get ComStringOf Of hoJResp "related_lists[i].api_name" To sApi_name
Get ComStringOf Of hoJResp "related_lists[i].module" To sModule
Get ComStringOf Of hoJResp "related_lists[i].name" To sName
Get ComStringOf Of hoJResp "related_lists[i].action" To sAction
Get ComStringOf Of hoJResp "related_lists[i].id" To sId
Get ComStringOf Of hoJResp "related_lists[i].href" To sHref
Get ComStringOf Of hoJResp "related_lists[i].type" To sV_type
Get ComStringOf Of hoJResp "related_lists[i].connectedmodule" To sConnectedmodule
Get ComStringOf Of hoJResp "related_lists[i].linkingmodule" To sLinkingmodule
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "module=Leads"
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/related_lists
Postman Collection Item JSON
{
"name": "Leads",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
},
"description": "To get the metadata of the Leads Module."
},
"response": [
{
"name": "P1: module",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 09:02:12 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-13T09:52:40+00:00"
},
{
"key": "clientVersion",
"value": "4031107"
},
{
"key": "clientsubVersion",
"value": "113b962796fc62946d9303284a64efab"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"related_lists\": [\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Notes\",\n \"api_name\": \"Notes\",\n \"module\": \"Notes\",\n \"name\": \"Notes\",\n \"action\": null,\n \"id\": \"738964000000002730\",\n \"href\": \"Leads/{ENTITYID}/Notes\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Lead Status History\",\n \"api_name\": \"Lead_Status_History\",\n \"module\": \"Lead_Status_History\",\n \"name\": \"Lead Status History\",\n \"action\": \"picklist_tracker\",\n \"id\": \"738964000001920298\",\n \"href\": \"Leads/{ENTITYID}/Lead_Status_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"2\",\n \"display_label\": \"Attachments\",\n \"api_name\": \"Attachments\",\n \"module\": \"Attachments\",\n \"name\": \"Attachments\",\n \"action\": null,\n \"id\": \"738964000000002724\",\n \"href\": \"Leads/{ENTITYID}/Attachments\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"3\",\n \"display_label\": \"Products\",\n \"api_name\": \"Products\",\n \"module\": \"Products\",\n \"name\": \"Products\",\n \"action\": null,\n \"id\": \"738964000000002726\",\n \"href\": \"Leads/{ENTITYID}/Products\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"4\",\n \"display_label\": \"Open Activities\",\n \"api_name\": \"Activities\",\n \"module\": \"Activities\",\n \"name\": \"Activities\",\n \"action\": null,\n \"id\": \"738964000000002722\",\n \"href\": \"Leads/{ENTITYID}/Activities\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"5\",\n \"display_label\": \"Closed Activities\",\n \"api_name\": \"Activities_History\",\n \"module\": \"Activities\",\n \"name\": \"Activities History\",\n \"action\": null,\n \"id\": \"738964000000002720\",\n \"href\": \"Leads/{ENTITYID}/Activities_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"6\",\n \"display_label\": \"Invited Meetings\",\n \"api_name\": \"Invited_Events\",\n \"module\": \"Events\",\n \"name\": \"Invited Events\",\n \"action\": null,\n \"id\": \"738964000000044001\",\n \"href\": \"Leads/{ENTITYID}/Invited_Events\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"7\",\n \"display_label\": \"Emails\",\n \"api_name\": \"Emails\",\n \"module\": \"Emails\",\n \"name\": \"Emails\",\n \"action\": null,\n \"id\": \"738964000000002728\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"8\",\n \"display_label\": \"Campaigns\",\n \"api_name\": \"Campaigns\",\n \"module\": \"Campaigns\",\n \"name\": \"Campaigns\",\n \"action\": null,\n \"id\": \"738964000000023017\",\n \"href\": \"Leads/{ENTITYID}/Campaigns\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"9\",\n \"display_label\": \"Social\",\n \"api_name\": \"Social\",\n \"module\": \"Social\",\n \"name\": \"Social\",\n \"action\": null,\n \"id\": \"738964000000048003\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"10\",\n \"display_label\": \"Checklists\",\n \"api_name\": \"CheckLists\",\n \"module\": \"CheckLists\",\n \"name\": \"CheckLists\",\n \"action\": null,\n \"id\": \"738964000000156005\",\n \"href\": \"Leads/{ENTITYID}/CheckLists\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"12\",\n \"display_label\": \"Deals\",\n \"api_name\": \"Deals8\",\n \"module\": \"Deals_X_Leads\",\n \"name\": \"Deals\",\n \"action\": null,\n \"id\": \"738964000001921504\",\n \"href\": \"Leads/{ENTITYID}/Deals8\",\n \"type\": \"multiselectlookup\",\n \"connectedmodule\": \"Potentials\",\n \"linkingmodule\": \"LinkingModule8\"\n }\n ]\n}"
},
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:26:36 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-05T12:33:08+05:30"
},
{
"key": "clientVersion",
"value": "4002155"
},
{
"key": "clientsubVersion",
"value": "bfb2326744b42e5c869a705645ac0006"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"related_lists\": [\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Lead Status History\",\n \"api_name\": \"Lead_Status_History\",\n \"module\": \"Lead_Status_History\",\n \"name\": \"Lead Status History\",\n \"action\": \"picklist_tracker\",\n \"id\": \"4150868000004783320\",\n \"href\": \"Leads/{ENTITYID}/Lead_Status_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Notes\",\n \"api_name\": \"Notes\",\n \"module\": \"Notes\",\n \"name\": \"Notes\",\n \"action\": null,\n \"id\": \"4150868000000015122\",\n \"href\": \"Leads/{ENTITYID}/Notes\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"2\",\n \"display_label\": \"Attachments\",\n \"api_name\": \"Attachments\",\n \"module\": \"Attachments\",\n \"name\": \"Attachments\",\n \"action\": null,\n \"id\": \"4150868000000003771\",\n \"href\": \"Leads/{ENTITYID}/Attachments\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"3\",\n \"display_label\": \"Products\",\n \"api_name\": \"Products\",\n \"module\": \"Products\",\n \"name\": \"Products\",\n \"action\": null,\n \"id\": \"4150868000000003773\",\n \"href\": \"Leads/{ENTITYID}/Products\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"4\",\n \"display_label\": \"Open Activities\",\n \"api_name\": \"Activities\",\n \"module\": \"Activities\",\n \"name\": \"Activities\",\n \"action\": null,\n \"id\": \"4150868000000003769\",\n \"href\": \"Leads/{ENTITYID}/Activities\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"5\",\n \"display_label\": \"Closed Activities\",\n \"api_name\": \"Activities_History\",\n \"module\": \"Activities\",\n \"name\": \"Activities History\",\n \"action\": null,\n \"id\": \"4150868000000003767\",\n \"href\": \"Leads/{ENTITYID}/Activities_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"6\",\n \"display_label\": \"Emails\",\n \"api_name\": \"Emails\",\n \"module\": \"Emails\",\n \"name\": \"Emails\",\n \"action\": null,\n \"id\": \"4150868000000014410\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"7\",\n \"display_label\": \"Invited Meetings\",\n \"api_name\": \"Invited_Events\",\n \"module\": \"Events\",\n \"name\": \"Invited Events\",\n \"action\": null,\n \"id\": \"4150868000000062001\",\n \"href\": \"Leads/{ENTITYID}/Invited_Events\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"8\",\n \"display_label\": \"Campaigns\",\n \"api_name\": \"Campaigns\",\n \"module\": \"Campaigns\",\n \"name\": \"Campaigns\",\n \"action\": null,\n \"id\": \"4150868000000040017\",\n \"href\": \"Leads/{ENTITYID}/Campaigns\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"9\",\n \"display_label\": \"Social\",\n \"api_name\": \"Social\",\n \"module\": \"Social\",\n \"name\": \"Social\",\n \"action\": null,\n \"id\": \"4150868000000065003\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"10\",\n \"display_label\": \"Checklists\",\n \"api_name\": \"CheckLists\",\n \"module\": \"CheckLists\",\n \"name\": \"CheckLists\",\n \"action\": null,\n \"id\": \"4150868000000141005\",\n \"href\": \"Leads/{ENTITYID}/CheckLists\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"11\",\n \"display_label\": \"Accounts1\",\n \"api_name\": \"Accounts15\",\n \"module\": \"Leads_X_Accounts\",\n \"name\": \"Accounts1\",\n \"action\": null,\n \"id\": \"4150868000000274089\",\n \"href\": \"Leads/{ENTITYID}/Accounts15\",\n \"type\": \"multiselectlookup\",\n \"connectedmodule\": \"Accounts\",\n \"linkingmodule\": \"LinkingModule5\"\n },\n {\n \"sequence_number\": \"13\",\n \"display_label\": \"Visits - Zoho\",\n \"api_name\": \"Visits_Zoho_Livedesk\",\n \"module\": \"Visits\",\n \"name\": \"Visits - Zoho Livedesk\",\n \"action\": null,\n \"id\": \"4150868000000493100\",\n \"href\": \"Leads/{ENTITYID}/Visits_Zoho_Livedesk\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"16\",\n \"display_label\": \"Related List Name 8\",\n \"api_name\": \"Related_List_Name_8\",\n \"module\": \"Contacts\",\n \"name\": \"Related List Name 8\",\n \"action\": null,\n \"id\": \"4150868000003813005\",\n \"href\": \"Leads/{ENTITYID}/Related_List_Name_8\",\n \"type\": \"custom_lookup\"\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Lead"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:26:58 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "110"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-05T12:33:08+05:30"
},
{
"key": "clientVersion",
"value": "4002155"
},
{
"key": "clientsubVersion",
"value": "bfb2326744b42e5c869a705645ac0006"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_MODULE\",\n \"details\": {},\n \"message\": \"the module name given seems to be invalid\",\n \"status\": \"error\"\n}"
},
{
"name": "REQUIRED_PARAM_MISSING",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:27:13 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "133"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"REQUIRED_PARAM_MISSING\",\n \"details\": {\n \"param\": \"module\"\n },\n \"message\": \"One of the expected parameter is missing\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Lead"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:27:35 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "110"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-05T12:33:08+05:30"
},
{
"key": "clientVersion",
"value": "4002155"
},
{
"key": "clientsubVersion",
"value": "bfb2326744b42e5c869a705645ac0006"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_MODULE\",\n \"details\": {},\n \"message\": \"the module name given seems to be invalid\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_listsmodule=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_listsmodule=Leads"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:27:55 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-05T12:33:08+05:30"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:28:14 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "PATCH",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:28:32 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:31:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
