Perl 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"

Perl Example

use chilkat();

$rest = chilkat::CkRest->new();

#  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/incidents
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
$success = $rest->Connect("my-dynamics-domain.api.crm.dynamics.com",$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$rest->AddQueryParam("$expand","customerid_account($select=accountid,name)");
$rest->AddQueryParam("$filter","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");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/api/data/v9.0/incidents",$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
if ($respStatusCode >= 400) {
    print "Response Status Code = " . $respStatusCode . "\r\n";
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    print "Response Body:" . "\r\n";
    print $sbResponseBody->getAsString() . "\r\n";
    exit;
}

$jsonResponse = chilkat::CkJsonObject->new();
$jsonResponse->LoadSb($sbResponseBody);

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

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"
      }
    }
  ]
}