Node.js Dynamics CRM: Find Tasks for an Incident

Back to Index

Returns tasks for a specific incident.

Documentation: https://docs.microsoft.com/en-us/dynamics365/customer-engagement/web-api/task?view=dynamics-ce-odata-9

CURL Command

curl -X GET https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/tasks \
  -H "Accept: application/json" \
  -H "OData-MaxVersion: 4.0"  \
  -H "OData-Version: 4.0" \
  -d "$select=subject,description,actualstart,activityid,_regardingobjectid_value" \
  -d "$filter=regardingobjectid_incident/incidentid eq c49e62a8-90df-e311-9565-a45d36fc5fe8" \
  -H "Authorization: Bearer DYNAMICS_CRM_ACCESS_TOKEN"

Node.js Example

var os = require('os');
if (os.platform() == 'win32') {  
    var chilkat = require('chilkat_node6_win32'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('chilkat_node6_arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('chilkat_node6_linux32');
    } else {
        var chilkat = require('chilkat_node6_linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('chilkat_node6_macosx');
}

function chilkatExample() {

    var rest = new chilkat.Rest();
    var success;

    //  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/tasks
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    success = rest.Connect("my-dynamics-domain.api.crm.dynamics.com",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    rest.AddQueryParam("$select","subject,description,actualstart,activityid,_regardingobjectid_value");
    rest.AddQueryParam("$filter","regardingobjectid_incident/incidentid eq c49e62a8-90df-e311-9565-a45d36fc5fe8");

    rest.AddHeader("OData-MaxVersion","4.0");
    rest.AddHeader("Accept","application/json");
    rest.AddHeader("OData-Version","4.0");
    rest.AddHeader("Authorization","Bearer DYNAMICS_CRM_ACCESS_TOKEN");

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("GET","/api/data/v9.0/tasks",sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var respStatusCode = rest.ResponseStatusCode;
    if (respStatusCode >= 400) {
        console.log("Response Status Code = " + respStatusCode);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(sbResponseBody.GetAsString());
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    var i;
    var count_i;

    var odataContext = jsonResponse.StringOf("\"@odata.context\"");
    i = 0;
    count_i = jsonResponse.SizeOfArray("value");
    while (i < count_i) {
        jsonResponse.I = i;
        var odataEtag = jsonResponse.StringOf("value[i].\"@odata.etag\"");
        var subject = jsonResponse.StringOf("value[i].subject");
        var description = jsonResponse.StringOf("value[i].description");
        var actualstart = jsonResponse.StringOf("value[i].actualstart");
        var activityid = jsonResponse.StringOf("value[i].activityid");
        var v_regardingobjectid_value = jsonResponse.StringOf("value[i]._regardingobjectid_value");
        i = i+1;
    }


}

chilkatExample();

Sample JSON Response Body

{
  "@odata.context": "https://mydomain.api.crm.dynamics.com/api/data/v9.0/$metadata#tasks(subject,description,actualstart,activityid,_regardingobjectid_value)",
  "value": [
    {
      "@odata.etag": "W/\"1173836\"",
      "subject": "Feedback on the product catalog",
      "description": "Defined and captured critical customer requirements for the product catalog. Reviewed the draft content with key players on the committee; recorded attendees. Generated email using the relevant template.",
      "actualstart": null,
      "activityid": "ca81ac0c-91df-e311-b8e5-6c3be5a8b200",
      "_regardingobjectid_value": "c49e62a8-90df-e311-9565-a45d36fc5fe8"
    }
  ]
}