C Dynamics CRM: Get All Information for a Specific Incident

Back to Index

Returns the entire JSON record for a specific incident.

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

CURL Command

curl -X GET https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/incidents \
  -H "Accept: application/json" \
  -H "OData-MaxVersion: 4.0"  \
  -H "OData-Version: 4.0" \
  -d "$expand=customerid_account($select=accountid,name)" \
  -d "$filter=incidentid eq c49e62a8-90df-e311-9565-a45d36fc5fe8" \
  -H "Authorization: Bearer DYNAMICS_CRM_ACCESS_TOKEN"

C Example

#include <C_CkRest.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkRest rest;
    BOOL success;
    BOOL bTls;
    int port;
    BOOL bAutoReconnect;
    HCkStringBuilder sbResponseBody;
    int respStatusCode;
    HCkJsonObject jsonResponse;
    int i;
    int count_i;
    const char *odataContext;
    const char *odataEtag;
    const char *v_resolvebykpiid_value;
    BOOL customercontacted;
    const char *v_accountid_value;
    int prioritycode;
    const char *v_msdyn_incidenttype_value;
    int caseorigincode;
    const char *modifiedon;
    const char *v_parentcaseid_value;
    const char *v_slainvokedid_value;
    const char *overriddencreatedon;
    BOOL isescalated;
    const char *int_paraturecasenumber;
    BOOL checkemail;
    const char *followupby;
    const char *ticketnumber;
    int versionnumber;
    const char *v_modifiedby_value;
    const char *billedserviceunits;
    BOOL decremententitlementterm;
    const char *onholdtime;
    const char *resolveby;
    BOOL int_upsellreferral;
    const char *messagetypecode;
    const char *emailaddress;
    BOOL merged;
    const char *int_surveryparticipation;
    const char *contractservicelevelcode;
    const char *v_createdonbehalfby_value;
    const char *v_contactid_value;
    const char *v_existingcase_value;
    const char *productserialnumber;
    const char *v_owninguser_value;
    const char *int_effortnum;
    const char *escalatedon;
    const char *v_productid_value;
    BOOL followuptaskcreated;
    const char *v_ownerid_value;
    const char *new_actualsatisfaction;
    const char *v_socialprofileid_value;
    const char *v_createdbyexternalparty_value;
    const char *v_contractid_value;
    const char *v_modifiedbyexternalparty_value;
    const char *v_masterid_value;
    int timezoneruleversionnumber;
    const char *entityimageid;
    const char *v_primarycontactid_value;
    int importsequencenumber;
    const char *v_owningteam_value;
    BOOL routecase;
    BOOL blockedprofile;
    int statecode;
    const char *int_casecategory;
    const char *entityimage_timestamp;
    int firstresponseslastatus;
    const char *traversedpath;
    const char *int_actualsatisfaction;
    const char *v_int_associatedproduct_value;
    const char *v_customerid_value;
    const char *entityimage;
    const char *v_entitlementid_value;
    BOOL activitiescomplete;
    const char *new_upsellreferral;
    int statuscode;
    const char *processid;
    const char *v_contractdetailid_value;
    int int_customereffort;
    const char *responseby;
    const char *v_transactioncurrencyid_value;
    const char *sentimentvalue;
    const char *v_slaid_value;
    const char *influencescore;
    const char *v_firstresponsebykpiid_value;
    const char *utcconversiontimezonecode;
    const char *numberofchildincidents;
    const char *incidentid;
    const char *new_casecategory;
    const char *v_owningbusinessunit_value;
    int casetypecode;
    int resolvebyslastatus;
    const char *createdon;
    int severitycode;
    const char *exchangerate;
    const char *v_subjectid_value;
    int servicestage;
    const char *description;
    const char *lastonholdtime;
    const char *actualserviceunits;
    const char *title;
    const char *v_createdby_value;
    BOOL isdecrementing;
    const char *v_modifiedonbehalfby_value;
    int customersatisfactioncode;
    const char *stageid;
    const char *v_kbarticleid_value;
    const char *entityimage_url;
    BOOL firstresponsesent;
    int incidentstagecode;
    const char *customerid_accountAccountid;
    const char *customerid_accountName;

    rest = CkRest_Create();

    //  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/incidents
    bTls = TRUE;
    port = 443;
    bAutoReconnect = TRUE;
    success = CkRest_Connect(rest,"my-dynamics-domain.api.crm.dynamics.com",port,bTls,bAutoReconnect);
    if (success != TRUE) {
        printf("ConnectFailReason: %d\n",CkRest_getConnectFailReason(rest));
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    CkRest_AddQueryParam(rest,"$expand","customerid_account($select=accountid,name)");
    CkRest_AddQueryParam(rest,"$filter","incidentid eq c49e62a8-90df-e311-9565-a45d36fc5fe8");

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

    sbResponseBody = CkStringBuilder_Create();
    success = CkRest_FullRequestNoBodySb(rest,"GET","/api/data/v9.0/incidents",sbResponseBody);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    respStatusCode = CkRest_getResponseStatusCode(rest);
    if (respStatusCode >= 400) {
        printf("Response Status Code = %d\n",respStatusCode);
        printf("Response Header:\n");
        printf("%s\n",CkRest_responseHeader(rest));
        printf("Response Body:\n");
        printf("%s\n",CkStringBuilder_getAsString(sbResponseBody));
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jsonResponse = CkJsonObject_Create();
    CkJsonObject_LoadSb(jsonResponse,sbResponseBody);

    odataContext = CkJsonObject_stringOf(jsonResponse,"\"@odata.context\"");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jsonResponse,"value");
    while (i < count_i) {
        CkJsonObject_putI(jsonResponse,i);
        odataEtag = CkJsonObject_stringOf(jsonResponse,"value[i].\"@odata.etag\"");
        v_resolvebykpiid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._resolvebykpiid_value");
        customercontacted = CkJsonObject_BoolOf(jsonResponse,"value[i].customercontacted");
        v_accountid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._accountid_value");
        prioritycode = CkJsonObject_IntOf(jsonResponse,"value[i].prioritycode");
        v_msdyn_incidenttype_value = CkJsonObject_stringOf(jsonResponse,"value[i]._msdyn_incidenttype_value");
        caseorigincode = CkJsonObject_IntOf(jsonResponse,"value[i].caseorigincode");
        modifiedon = CkJsonObject_stringOf(jsonResponse,"value[i].modifiedon");
        v_parentcaseid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._parentcaseid_value");
        v_slainvokedid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._slainvokedid_value");
        overriddencreatedon = CkJsonObject_stringOf(jsonResponse,"value[i].overriddencreatedon");
        isescalated = CkJsonObject_BoolOf(jsonResponse,"value[i].isescalated");
        int_paraturecasenumber = CkJsonObject_stringOf(jsonResponse,"value[i].int_paraturecasenumber");
        checkemail = CkJsonObject_BoolOf(jsonResponse,"value[i].checkemail");
        followupby = CkJsonObject_stringOf(jsonResponse,"value[i].followupby");
        ticketnumber = CkJsonObject_stringOf(jsonResponse,"value[i].ticketnumber");
        versionnumber = CkJsonObject_IntOf(jsonResponse,"value[i].versionnumber");
        v_modifiedby_value = CkJsonObject_stringOf(jsonResponse,"value[i]._modifiedby_value");
        billedserviceunits = CkJsonObject_stringOf(jsonResponse,"value[i].billedserviceunits");
        decremententitlementterm = CkJsonObject_BoolOf(jsonResponse,"value[i].decremententitlementterm");
        onholdtime = CkJsonObject_stringOf(jsonResponse,"value[i].onholdtime");
        resolveby = CkJsonObject_stringOf(jsonResponse,"value[i].resolveby");
        int_upsellreferral = CkJsonObject_BoolOf(jsonResponse,"value[i].int_upsellreferral");
        messagetypecode = CkJsonObject_stringOf(jsonResponse,"value[i].messagetypecode");
        emailaddress = CkJsonObject_stringOf(jsonResponse,"value[i].emailaddress");
        merged = CkJsonObject_BoolOf(jsonResponse,"value[i].merged");
        int_surveryparticipation = CkJsonObject_stringOf(jsonResponse,"value[i].int_surveryparticipation");
        contractservicelevelcode = CkJsonObject_stringOf(jsonResponse,"value[i].contractservicelevelcode");
        v_createdonbehalfby_value = CkJsonObject_stringOf(jsonResponse,"value[i]._createdonbehalfby_value");
        v_contactid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._contactid_value");
        v_existingcase_value = CkJsonObject_stringOf(jsonResponse,"value[i]._existingcase_value");
        productserialnumber = CkJsonObject_stringOf(jsonResponse,"value[i].productserialnumber");
        v_owninguser_value = CkJsonObject_stringOf(jsonResponse,"value[i]._owninguser_value");
        int_effortnum = CkJsonObject_stringOf(jsonResponse,"value[i].int_effortnum");
        escalatedon = CkJsonObject_stringOf(jsonResponse,"value[i].escalatedon");
        v_productid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._productid_value");
        followuptaskcreated = CkJsonObject_BoolOf(jsonResponse,"value[i].followuptaskcreated");
        v_ownerid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._ownerid_value");
        new_actualsatisfaction = CkJsonObject_stringOf(jsonResponse,"value[i].new_actualsatisfaction");
        v_socialprofileid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._socialprofileid_value");
        v_createdbyexternalparty_value = CkJsonObject_stringOf(jsonResponse,"value[i]._createdbyexternalparty_value");
        v_contractid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._contractid_value");
        v_modifiedbyexternalparty_value = CkJsonObject_stringOf(jsonResponse,"value[i]._modifiedbyexternalparty_value");
        v_masterid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._masterid_value");
        timezoneruleversionnumber = CkJsonObject_IntOf(jsonResponse,"value[i].timezoneruleversionnumber");
        entityimageid = CkJsonObject_stringOf(jsonResponse,"value[i].entityimageid");
        v_primarycontactid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._primarycontactid_value");
        importsequencenumber = CkJsonObject_IntOf(jsonResponse,"value[i].importsequencenumber");
        v_owningteam_value = CkJsonObject_stringOf(jsonResponse,"value[i]._owningteam_value");
        routecase = CkJsonObject_BoolOf(jsonResponse,"value[i].routecase");
        blockedprofile = CkJsonObject_BoolOf(jsonResponse,"value[i].blockedprofile");
        statecode = CkJsonObject_IntOf(jsonResponse,"value[i].statecode");
        int_casecategory = CkJsonObject_stringOf(jsonResponse,"value[i].int_casecategory");
        entityimage_timestamp = CkJsonObject_stringOf(jsonResponse,"value[i].entityimage_timestamp");
        firstresponseslastatus = CkJsonObject_IntOf(jsonResponse,"value[i].firstresponseslastatus");
        traversedpath = CkJsonObject_stringOf(jsonResponse,"value[i].traversedpath");
        int_actualsatisfaction = CkJsonObject_stringOf(jsonResponse,"value[i].int_actualsatisfaction");
        v_int_associatedproduct_value = CkJsonObject_stringOf(jsonResponse,"value[i]._int_associatedproduct_value");
        v_customerid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._customerid_value");
        entityimage = CkJsonObject_stringOf(jsonResponse,"value[i].entityimage");
        v_entitlementid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._entitlementid_value");
        activitiescomplete = CkJsonObject_BoolOf(jsonResponse,"value[i].activitiescomplete");
        new_upsellreferral = CkJsonObject_stringOf(jsonResponse,"value[i].new_upsellreferral");
        statuscode = CkJsonObject_IntOf(jsonResponse,"value[i].statuscode");
        processid = CkJsonObject_stringOf(jsonResponse,"value[i].processid");
        v_contractdetailid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._contractdetailid_value");
        int_customereffort = CkJsonObject_IntOf(jsonResponse,"value[i].int_customereffort");
        responseby = CkJsonObject_stringOf(jsonResponse,"value[i].responseby");
        v_transactioncurrencyid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._transactioncurrencyid_value");
        sentimentvalue = CkJsonObject_stringOf(jsonResponse,"value[i].sentimentvalue");
        v_slaid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._slaid_value");
        influencescore = CkJsonObject_stringOf(jsonResponse,"value[i].influencescore");
        v_firstresponsebykpiid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._firstresponsebykpiid_value");
        utcconversiontimezonecode = CkJsonObject_stringOf(jsonResponse,"value[i].utcconversiontimezonecode");
        numberofchildincidents = CkJsonObject_stringOf(jsonResponse,"value[i].numberofchildincidents");
        incidentid = CkJsonObject_stringOf(jsonResponse,"value[i].incidentid");
        new_casecategory = CkJsonObject_stringOf(jsonResponse,"value[i].new_casecategory");
        v_owningbusinessunit_value = CkJsonObject_stringOf(jsonResponse,"value[i]._owningbusinessunit_value");
        casetypecode = CkJsonObject_IntOf(jsonResponse,"value[i].casetypecode");
        resolvebyslastatus = CkJsonObject_IntOf(jsonResponse,"value[i].resolvebyslastatus");
        createdon = CkJsonObject_stringOf(jsonResponse,"value[i].createdon");
        severitycode = CkJsonObject_IntOf(jsonResponse,"value[i].severitycode");
        exchangerate = CkJsonObject_stringOf(jsonResponse,"value[i].exchangerate");
        v_subjectid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._subjectid_value");
        servicestage = CkJsonObject_IntOf(jsonResponse,"value[i].servicestage");
        description = CkJsonObject_stringOf(jsonResponse,"value[i].description");
        lastonholdtime = CkJsonObject_stringOf(jsonResponse,"value[i].lastonholdtime");
        actualserviceunits = CkJsonObject_stringOf(jsonResponse,"value[i].actualserviceunits");
        title = CkJsonObject_stringOf(jsonResponse,"value[i].title");
        v_createdby_value = CkJsonObject_stringOf(jsonResponse,"value[i]._createdby_value");
        isdecrementing = CkJsonObject_BoolOf(jsonResponse,"value[i].isdecrementing");
        v_modifiedonbehalfby_value = CkJsonObject_stringOf(jsonResponse,"value[i]._modifiedonbehalfby_value");
        customersatisfactioncode = CkJsonObject_IntOf(jsonResponse,"value[i].customersatisfactioncode");
        stageid = CkJsonObject_stringOf(jsonResponse,"value[i].stageid");
        v_kbarticleid_value = CkJsonObject_stringOf(jsonResponse,"value[i]._kbarticleid_value");
        entityimage_url = CkJsonObject_stringOf(jsonResponse,"value[i].entityimage_url");
        firstresponsesent = CkJsonObject_BoolOf(jsonResponse,"value[i].firstresponsesent");
        incidentstagecode = CkJsonObject_IntOf(jsonResponse,"value[i].incidentstagecode");
        customerid_accountAccountid = CkJsonObject_stringOf(jsonResponse,"value[i].customerid_account.accountid");
        customerid_accountName = CkJsonObject_stringOf(jsonResponse,"value[i].customerid_account.name");
        i = i + 1;
    }



    CkRest_Dispose(rest);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jsonResponse);

    }

Sample JSON Response Body

{
  "@odata.context": "https://mydomain.api.crm.dynamics.com/api/data/v9.0/$metadata#incidents(customerid_account(accountid,name))",
  "value": [
    {
      "@odata.etag": "W/\"1161596\"",
      "_resolvebykpiid_value": null,
      "customercontacted": false,
      "_accountid_value": null,
      "prioritycode": 2,
      "_msdyn_incidenttype_value": null,
      "caseorigincode": 2,
      "modifiedon": "2018-03-03T12:34:48Z",
      "_parentcaseid_value": null,
      "_slainvokedid_value": null,
      "overriddencreatedon": "2018-03-03T12:34:48Z",
      "isescalated": false,
      "int_paraturecasenumber": null,
      "checkemail": false,
      "followupby": "2015-06-04T16:15:42Z",
      "ticketnumber": "CAS-01220-S1K8F4",
      "versionnumber": 1161596,
      "_modifiedby_value": "32ff7175-0dbe-4acb-872e-22f86435bf98",
      "billedserviceunits": null,
      "decremententitlementterm": true,
      "onholdtime": null,
      "resolveby": "2015-06-05T16:15:42Z",
      "int_upsellreferral": false,
      "messagetypecode": null,
      "emailaddress": null,
      "merged": false,
      "int_surveryparticipation": null,
      "contractservicelevelcode": null,
      "_createdonbehalfby_value": null,
      "_contactid_value": null,
      "_existingcase_value": null,
      "productserialnumber": null,
      "_owninguser_value": "32ff7175-0dbe-4acb-872e-22f86435bf98",
      "int_effortnum": null,
      "escalatedon": null,
      "_productid_value": "3509d8af-7bc3-e411-80df-fc15b42886e8",
      "followuptaskcreated": false,
      "_ownerid_value": "32ff7175-0dbe-4acb-872e-22f86435bf98",
      "new_actualsatisfaction": null,
      "_socialprofileid_value": null,
      "_createdbyexternalparty_value": null,
      "_contractid_value": null,
      "_modifiedbyexternalparty_value": null,
      "_masterid_value": null,
      "timezoneruleversionnumber": 0,
      "entityimageid": null,
      "_primarycontactid_value": null,
      "importsequencenumber": 124,
      "_owningteam_value": null,
      "routecase": true,
      "blockedprofile": false,
      "statecode": 0,
      "int_casecategory": null,
      "entityimage_timestamp": null,
      "firstresponseslastatus": 1,
      "traversedpath": null,
      "int_actualsatisfaction": null,
      "_int_associatedproduct_value": null,
      "_customerid_value": "b6a19cdd-88df-e311-b8e5-6c3be5a8b200",
      "entityimage": null,
      "_entitlementid_value": null,
      "activitiescomplete": false,
      "new_upsellreferral": null,
      "statuscode": 1,
      "processid": "0ffbcde4-61c1-4355-aa89-aa1d7b2b8792",
      "_contractdetailid_value": null,
      "int_customereffort": 121590000,
      "responseby": null,
      "_transactioncurrencyid_value": null,
      "sentimentvalue": null,
      "_slaid_value": null,
      "influencescore": null,
      "_firstresponsebykpiid_value": null,
      "utcconversiontimezonecode": null,
      "numberofchildincidents": null,
      "incidentid": "c49e62a8-90df-e311-9565-a45d36fc5fe8",
      "new_casecategory": null,
      "_owningbusinessunit_value": "c4106190-c81e-e811-a980-000d3a192e9a",
      "casetypecode": 2,
      "resolvebyslastatus": 1,
      "createdon": "2017-01-20T22:50:47Z",
      "severitycode": 1,
      "exchangerate": null,
      "_subjectid_value": "191de3d1-21d5-e411-80eb-c4346bad3638",
      "servicestage": 0,
      "description": null,
      "lastonholdtime": null,
      "actualserviceunits": null,
      "title": "Faulty product catalog",
      "_createdby_value": "32ff7175-0dbe-4acb-872e-22f86435bf98",
      "isdecrementing": false,
      "_modifiedonbehalfby_value": null,
      "customersatisfactioncode": 3,
      "stageid": "92a6721b-d465-4d36-aef7-e8822d7a5a6a",
      "_kbarticleid_value": null,
      "entityimage_url": null,
      "firstresponsesent": false,
      "incidentstagecode": 1,
      "customerid_account": {
        "accountid": "b6a19cdd-88df-e311-b8e5-6c3be5a8b200",
        "name": "Fourth Coffee"
      }
    }
  ]
}