Chilkat Online Tools

Node.js / Zoho CRM REST APIs / Assignment Rules

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>";

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://domain.com/crm/v2.1/settings/automation/assignment_rules",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "assignment_rules": [
    //     {
    //       "created_time": "2020-03-30T00:00:00+05:30",
    //       "modified_time": "2020-03-30T21:14:07+05:30",
    //       "default_assignee": {
    //         "name": "User 3",
    //         "id": "4150868000001248015"
    //       },
    //       "module": {
    //         "api_name": "Leads",
    //         "id": "4150868000000002175"
    //       },
    //       "name": "test assignment rules",
    //       "modified_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       },
    //       "description": "Assign owner to a record",
    //       "id": "4150868000001730013",
    //       "created_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       }
    //     },
    //     {
    //       "created_time": "2020-03-30T00:00:00+05:30",
    //       "modified_time": "2020-03-30T20:44:25+05:30",
    //       "default_assignee": {
    //         "name": "User 3",
    //         "id": "4150868000001248015"
    //       },
    //       "module": {
    //         "api_name": "Leads",
    //         "id": "4150868000000002175"
    //       },
    //       "name": "test assignment rules2",
    //       "modified_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       },
    //       "description": "Assign owner to a record",
    //       "id": "4150868000001741002",
    //       "created_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       }
    //     },
    //     {
    //       "created_time": "2020-03-30T00:00:00+05:30",
    //       "modified_time": "2020-03-30T00:00:00+05:30",
    //       "default_assignee": {
    //         "name": "User 3",
    //         "id": "4150868000001248015"
    //       },
    //       "module": {
    //         "api_name": "Leads",
    //         "id": "4150868000000002175"
    //       },
    //       "name": "test assignment rules3",
    //       "modified_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       },
    //       "description": "Assign owner to a record",
    //       "id": "4150868000001741010",
    //       "created_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       }
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var created_time;
    var modified_time;
    var Name;
    var Id;
    var Api_name;
    var moduleId;
    var name;
    var modified_byName;
    var modified_byId;
    var description;
    var id;
    var created_byName;
    var created_byId;

    var i = 0;
    var count_i = jResp.SizeOfArray("assignment_rules");
    while (i < count_i) {
        jResp.I = i;
        created_time = jResp.StringOf("assignment_rules[i].created_time");
        modified_time = jResp.StringOf("assignment_rules[i].modified_time");
        Name = jResp.StringOf("assignment_rules[i].default_assignee.name");
        Id = jResp.StringOf("assignment_rules[i].default_assignee.id");
        Api_name = jResp.StringOf("assignment_rules[i].module.api_name");
        moduleId = jResp.StringOf("assignment_rules[i].module.id");
        name = jResp.StringOf("assignment_rules[i].name");
        modified_byName = jResp.StringOf("assignment_rules[i].modified_by.name");
        modified_byId = jResp.StringOf("assignment_rules[i].modified_by.id");
        description = jResp.StringOf("assignment_rules[i].description");
        id = jResp.StringOf("assignment_rules[i].id");
        created_byName = jResp.StringOf("assignment_rules[i].created_by.name");
        created_byId = jResp.StringOf("assignment_rules[i].created_by.id");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/automation/assignment_rules

Postman Collection Item JSON

{
  "name": "Assignment Rules",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "settings",
        "automation",
        "assignment_rules"
      ]
    }
  },
  "response": [
    {
      "name": "P1: module",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules?module=Leads",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "automation",
            "assignment_rules"
          ],
          "query": [
            {
              "key": "module",
              "value": "Leads"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 10:52:53 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-10T17:05:19+05:30"
        },
        {
          "key": "clientVersion",
          "value": "4016246"
        },
        {
          "key": "clientsubVersion",
          "value": "59f8474ad0046d6a2f6204e0448818d0"
        },
        {
          "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    \"assignment_rules\": [\n        {\n            \"created_time\": \"2020-03-30T00:00:00+05:30\",\n            \"modified_time\": \"2020-03-30T21:14:07+05:30\",\n            \"default_assignee\": {\n                \"name\": \"User 3\",\n                \"id\": \"4150868000001248015\"\n            },\n            \"module\": {\n                \"api_name\": \"Leads\",\n                \"id\": \"4150868000000002175\"\n            },\n            \"name\": \"test assignment rules\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"Assign owner to a record\",\n            \"id\": \"4150868000001730013\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        },\n        {\n            \"created_time\": \"2020-03-30T00:00:00+05:30\",\n            \"modified_time\": \"2020-03-30T20:44:25+05:30\",\n            \"default_assignee\": {\n                \"name\": \"User 3\",\n                \"id\": \"4150868000001248015\"\n            },\n            \"module\": {\n                \"api_name\": \"Leads\",\n                \"id\": \"4150868000000002175\"\n            },\n            \"name\": \"test assignment rules2\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"Assign owner to a record\",\n            \"id\": \"4150868000001741002\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        },\n        {\n            \"created_time\": \"2020-03-30T00:00:00+05:30\",\n            \"modified_time\": \"2020-03-30T00:00:00+05:30\",\n            \"default_assignee\": {\n                \"name\": \"User 3\",\n                \"id\": \"4150868000001248015\"\n            },\n            \"module\": {\n                \"api_name\": \"Leads\",\n                \"id\": \"4150868000000002175\"\n            },\n            \"name\": \"test assignment rules3\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"Assign owner to a record\",\n            \"id\": \"4150868000001741010\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        }\n    ]\n}"
    },
    {
      "name": "SUCCESS RESPONSE",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "automation",
            "assignment_rules"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 10:51:06 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-10T17:05:19+05:30"
        },
        {
          "key": "clientVersion",
          "value": "4016246"
        },
        {
          "key": "clientsubVersion",
          "value": "59f8474ad0046d6a2f6204e0448818d0"
        },
        {
          "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    \"assignment_rules\": [\n        {\n            \"created_time\": \"2020-03-30T00:00:00+05:30\",\n            \"modified_time\": \"2020-03-30T21:14:07+05:30\",\n            \"default_assignee\": {\n                \"name\": \"User 3\",\n                \"id\": \"4150868000001248015\"\n            },\n            \"module\": {\n                \"api_name\": \"Leads\",\n                \"id\": \"4150868000000002175\"\n            },\n            \"name\": \"test assignment rules\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"Assign owner to a record\",\n            \"id\": \"4150868000001730013\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        },\n        {\n            \"created_time\": \"2020-03-30T00:00:00+05:30\",\n            \"modified_time\": \"2020-03-30T20:44:25+05:30\",\n            \"default_assignee\": {\n                \"name\": \"User 3\",\n                \"id\": \"4150868000001248015\"\n            },\n            \"module\": {\n                \"api_name\": \"Leads\",\n                \"id\": \"4150868000000002175\"\n            },\n            \"name\": \"test assignment rules2\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"Assign owner to a record\",\n            \"id\": \"4150868000001741002\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        },\n        {\n            \"created_time\": \"2020-03-30T00:00:00+05:30\",\n            \"modified_time\": \"2020-03-30T00:00:00+05:30\",\n            \"default_assignee\": {\n                \"name\": \"User 3\",\n                \"id\": \"4150868000001248015\"\n            },\n            \"module\": {\n                \"api_name\": \"Leads\",\n                \"id\": \"4150868000000002175\"\n            },\n            \"name\": \"test assignment rules3\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"Assign owner to a record\",\n            \"id\": \"4150868000001741010\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        }\n    ]\n}"
    },
    {
      "name": "INVALID_REQUEST_METHOD",
      "originalRequest": {
        "method": "COPY",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "automation",
            "assignment_rules"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 10:51:35 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": "INVALID_URL_PATTERN",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rule",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "automation",
            "assignment_rule"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 10:52:31 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-10T17:05:19+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": "OAUTH_SCOPE_MISMATCH",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "automation",
            "assignment_rules"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Thu, 13 May 2021 08:41:22 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}"
    }
  ]
}