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

PowerBuilder Example

integer li_rc
oleobject loo_Rest
integer li_Success
integer li_BTls
integer li_Port
integer li_BAutoReconnect
oleobject loo_SbResponseBody
integer li_RespStatusCode
oleobject loo_JsonResponse
integer i
integer li_Count_i
string ls_OdataContext
string ls_OdataEtag
string ls_V_resolvebykpiid_value
integer li_Customercontacted
string ls_V_accountid_value
integer li_Prioritycode
string ls_V_msdyn_incidenttype_value
integer li_Caseorigincode
string ls_Modifiedon
string ls_V_parentcaseid_value
string ls_V_slainvokedid_value
string ls_Overriddencreatedon
integer li_Isescalated
string ls_Int_paraturecasenumber
integer li_Checkemail
string ls_Followupby
string ls_Ticketnumber
integer li_Versionnumber
string ls_V_modifiedby_value
string ls_Billedserviceunits
integer li_Decremententitlementterm
string ls_Onholdtime
string ls_Resolveby
integer li_Int_upsellreferral
string ls_Messagetypecode
string ls_Emailaddress
integer li_Merged
string ls_Int_surveryparticipation
string ls_Contractservicelevelcode
string ls_V_createdonbehalfby_value
string ls_V_contactid_value
string ls_V_existingcase_value
string ls_Productserialnumber
string ls_V_owninguser_value
string ls_Int_effortnum
string ls_Escalatedon
string ls_V_productid_value
integer li_Followuptaskcreated
string ls_V_ownerid_value
string ls_New_actualsatisfaction
string ls_V_socialprofileid_value
string ls_V_createdbyexternalparty_value
string ls_V_contractid_value
string ls_V_modifiedbyexternalparty_value
string ls_V_masterid_value
integer li_Timezoneruleversionnumber
string ls_Entityimageid
string ls_V_primarycontactid_value
integer li_Importsequencenumber
string ls_V_owningteam_value
integer li_Routecase
integer li_Blockedprofile
integer li_Statecode
string ls_Int_casecategory
string ls_Entityimage_timestamp
integer li_Firstresponseslastatus
string ls_Traversedpath
string ls_Int_actualsatisfaction
string ls_V_int_associatedproduct_value
string ls_V_customerid_value
string ls_Entityimage
string ls_V_entitlementid_value
integer li_Activitiescomplete
string ls_New_upsellreferral
integer li_Statuscode
string ls_Processid
string ls_V_contractdetailid_value
integer li_Int_customereffort
string ls_Responseby
string ls_V_transactioncurrencyid_value
string ls_Sentimentvalue
string ls_V_slaid_value
string ls_Influencescore
string ls_V_firstresponsebykpiid_value
string ls_Utcconversiontimezonecode
string ls_Numberofchildincidents
string ls_Incidentid
string ls_New_casecategory
string ls_V_owningbusinessunit_value
integer li_Casetypecode
integer li_Resolvebyslastatus
string ls_Createdon
integer li_Severitycode
string ls_Exchangerate
string ls_V_subjectid_value
integer li_Servicestage
string ls_Description
string ls_Lastonholdtime
string ls_Actualserviceunits
string ls_Title
string ls_V_createdby_value
integer li_Isdecrementing
string ls_V_modifiedonbehalfby_value
integer li_Customersatisfactioncode
string ls_Stageid
string ls_V_kbarticleid_value
string ls_Entityimage_url
integer li_Firstresponsesent
integer li_Incidentstagecode
string ls_Customerid_accountAccountid
string ls_Customerid_accountName

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat_9_5_0.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/incidents
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("my-dynamics-domain.api.crm.dynamics.com",li_Port,li_BTls,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug "ConnectFailReason: " + string(loo_Rest.ConnectFailReason)
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

loo_Rest.AddQueryParam("$expand","customerid_account($select=accountid,name)")
loo_Rest.AddQueryParam("$filter","incidentid eq c49e62a8-90df-e311-9565-a45d36fc5fe8")

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

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Rest.FullRequestNoBodySb("GET","/api/data/v9.0/incidents",loo_SbResponseBody)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_SbResponseBody
    return
end if

li_RespStatusCode = loo_Rest.ResponseStatusCode
if li_RespStatusCode >= 400 then
    Write-Debug "Response Status Code = " + string(li_RespStatusCode)
    Write-Debug "Response Header:"
    Write-Debug loo_Rest.ResponseHeader
    Write-Debug "Response Body:"
    Write-Debug loo_SbResponseBody.GetAsString()
    destroy loo_Rest
    destroy loo_SbResponseBody
    return
end if

loo_JsonResponse = create oleobject
li_rc = loo_JsonResponse.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JsonResponse.LoadSb(loo_SbResponseBody)

ls_OdataContext = loo_JsonResponse.StringOf("\"@odata.context\"")
i = 0
li_Count_i = loo_JsonResponse.SizeOfArray("value")
do while i < li_Count_i
    loo_JsonResponse.I = i
    ls_OdataEtag = loo_JsonResponse.StringOf("value[i].\"@odata.etag\"")
    ls_V_resolvebykpiid_value = loo_JsonResponse.StringOf("value[i]._resolvebykpiid_value")
    li_Customercontacted = loo_JsonResponse.BoolOf("value[i].customercontacted")
    ls_V_accountid_value = loo_JsonResponse.StringOf("value[i]._accountid_value")
    li_Prioritycode = loo_JsonResponse.IntOf("value[i].prioritycode")
    ls_V_msdyn_incidenttype_value = loo_JsonResponse.StringOf("value[i]._msdyn_incidenttype_value")
    li_Caseorigincode = loo_JsonResponse.IntOf("value[i].caseorigincode")
    ls_Modifiedon = loo_JsonResponse.StringOf("value[i].modifiedon")
    ls_V_parentcaseid_value = loo_JsonResponse.StringOf("value[i]._parentcaseid_value")
    ls_V_slainvokedid_value = loo_JsonResponse.StringOf("value[i]._slainvokedid_value")
    ls_Overriddencreatedon = loo_JsonResponse.StringOf("value[i].overriddencreatedon")
    li_Isescalated = loo_JsonResponse.BoolOf("value[i].isescalated")
    ls_Int_paraturecasenumber = loo_JsonResponse.StringOf("value[i].int_paraturecasenumber")
    li_Checkemail = loo_JsonResponse.BoolOf("value[i].checkemail")
    ls_Followupby = loo_JsonResponse.StringOf("value[i].followupby")
    ls_Ticketnumber = loo_JsonResponse.StringOf("value[i].ticketnumber")
    li_Versionnumber = loo_JsonResponse.IntOf("value[i].versionnumber")
    ls_V_modifiedby_value = loo_JsonResponse.StringOf("value[i]._modifiedby_value")
    ls_Billedserviceunits = loo_JsonResponse.StringOf("value[i].billedserviceunits")
    li_Decremententitlementterm = loo_JsonResponse.BoolOf("value[i].decremententitlementterm")
    ls_Onholdtime = loo_JsonResponse.StringOf("value[i].onholdtime")
    ls_Resolveby = loo_JsonResponse.StringOf("value[i].resolveby")
    li_Int_upsellreferral = loo_JsonResponse.BoolOf("value[i].int_upsellreferral")
    ls_Messagetypecode = loo_JsonResponse.StringOf("value[i].messagetypecode")
    ls_Emailaddress = loo_JsonResponse.StringOf("value[i].emailaddress")
    li_Merged = loo_JsonResponse.BoolOf("value[i].merged")
    ls_Int_surveryparticipation = loo_JsonResponse.StringOf("value[i].int_surveryparticipation")
    ls_Contractservicelevelcode = loo_JsonResponse.StringOf("value[i].contractservicelevelcode")
    ls_V_createdonbehalfby_value = loo_JsonResponse.StringOf("value[i]._createdonbehalfby_value")
    ls_V_contactid_value = loo_JsonResponse.StringOf("value[i]._contactid_value")
    ls_V_existingcase_value = loo_JsonResponse.StringOf("value[i]._existingcase_value")
    ls_Productserialnumber = loo_JsonResponse.StringOf("value[i].productserialnumber")
    ls_V_owninguser_value = loo_JsonResponse.StringOf("value[i]._owninguser_value")
    ls_Int_effortnum = loo_JsonResponse.StringOf("value[i].int_effortnum")
    ls_Escalatedon = loo_JsonResponse.StringOf("value[i].escalatedon")
    ls_V_productid_value = loo_JsonResponse.StringOf("value[i]._productid_value")
    li_Followuptaskcreated = loo_JsonResponse.BoolOf("value[i].followuptaskcreated")
    ls_V_ownerid_value = loo_JsonResponse.StringOf("value[i]._ownerid_value")
    ls_New_actualsatisfaction = loo_JsonResponse.StringOf("value[i].new_actualsatisfaction")
    ls_V_socialprofileid_value = loo_JsonResponse.StringOf("value[i]._socialprofileid_value")
    ls_V_createdbyexternalparty_value = loo_JsonResponse.StringOf("value[i]._createdbyexternalparty_value")
    ls_V_contractid_value = loo_JsonResponse.StringOf("value[i]._contractid_value")
    ls_V_modifiedbyexternalparty_value = loo_JsonResponse.StringOf("value[i]._modifiedbyexternalparty_value")
    ls_V_masterid_value = loo_JsonResponse.StringOf("value[i]._masterid_value")
    li_Timezoneruleversionnumber = loo_JsonResponse.IntOf("value[i].timezoneruleversionnumber")
    ls_Entityimageid = loo_JsonResponse.StringOf("value[i].entityimageid")
    ls_V_primarycontactid_value = loo_JsonResponse.StringOf("value[i]._primarycontactid_value")
    li_Importsequencenumber = loo_JsonResponse.IntOf("value[i].importsequencenumber")
    ls_V_owningteam_value = loo_JsonResponse.StringOf("value[i]._owningteam_value")
    li_Routecase = loo_JsonResponse.BoolOf("value[i].routecase")
    li_Blockedprofile = loo_JsonResponse.BoolOf("value[i].blockedprofile")
    li_Statecode = loo_JsonResponse.IntOf("value[i].statecode")
    ls_Int_casecategory = loo_JsonResponse.StringOf("value[i].int_casecategory")
    ls_Entityimage_timestamp = loo_JsonResponse.StringOf("value[i].entityimage_timestamp")
    li_Firstresponseslastatus = loo_JsonResponse.IntOf("value[i].firstresponseslastatus")
    ls_Traversedpath = loo_JsonResponse.StringOf("value[i].traversedpath")
    ls_Int_actualsatisfaction = loo_JsonResponse.StringOf("value[i].int_actualsatisfaction")
    ls_V_int_associatedproduct_value = loo_JsonResponse.StringOf("value[i]._int_associatedproduct_value")
    ls_V_customerid_value = loo_JsonResponse.StringOf("value[i]._customerid_value")
    ls_Entityimage = loo_JsonResponse.StringOf("value[i].entityimage")
    ls_V_entitlementid_value = loo_JsonResponse.StringOf("value[i]._entitlementid_value")
    li_Activitiescomplete = loo_JsonResponse.BoolOf("value[i].activitiescomplete")
    ls_New_upsellreferral = loo_JsonResponse.StringOf("value[i].new_upsellreferral")
    li_Statuscode = loo_JsonResponse.IntOf("value[i].statuscode")
    ls_Processid = loo_JsonResponse.StringOf("value[i].processid")
    ls_V_contractdetailid_value = loo_JsonResponse.StringOf("value[i]._contractdetailid_value")
    li_Int_customereffort = loo_JsonResponse.IntOf("value[i].int_customereffort")
    ls_Responseby = loo_JsonResponse.StringOf("value[i].responseby")
    ls_V_transactioncurrencyid_value = loo_JsonResponse.StringOf("value[i]._transactioncurrencyid_value")
    ls_Sentimentvalue = loo_JsonResponse.StringOf("value[i].sentimentvalue")
    ls_V_slaid_value = loo_JsonResponse.StringOf("value[i]._slaid_value")
    ls_Influencescore = loo_JsonResponse.StringOf("value[i].influencescore")
    ls_V_firstresponsebykpiid_value = loo_JsonResponse.StringOf("value[i]._firstresponsebykpiid_value")
    ls_Utcconversiontimezonecode = loo_JsonResponse.StringOf("value[i].utcconversiontimezonecode")
    ls_Numberofchildincidents = loo_JsonResponse.StringOf("value[i].numberofchildincidents")
    ls_Incidentid = loo_JsonResponse.StringOf("value[i].incidentid")
    ls_New_casecategory = loo_JsonResponse.StringOf("value[i].new_casecategory")
    ls_V_owningbusinessunit_value = loo_JsonResponse.StringOf("value[i]._owningbusinessunit_value")
    li_Casetypecode = loo_JsonResponse.IntOf("value[i].casetypecode")
    li_Resolvebyslastatus = loo_JsonResponse.IntOf("value[i].resolvebyslastatus")
    ls_Createdon = loo_JsonResponse.StringOf("value[i].createdon")
    li_Severitycode = loo_JsonResponse.IntOf("value[i].severitycode")
    ls_Exchangerate = loo_JsonResponse.StringOf("value[i].exchangerate")
    ls_V_subjectid_value = loo_JsonResponse.StringOf("value[i]._subjectid_value")
    li_Servicestage = loo_JsonResponse.IntOf("value[i].servicestage")
    ls_Description = loo_JsonResponse.StringOf("value[i].description")
    ls_Lastonholdtime = loo_JsonResponse.StringOf("value[i].lastonholdtime")
    ls_Actualserviceunits = loo_JsonResponse.StringOf("value[i].actualserviceunits")
    ls_Title = loo_JsonResponse.StringOf("value[i].title")
    ls_V_createdby_value = loo_JsonResponse.StringOf("value[i]._createdby_value")
    li_Isdecrementing = loo_JsonResponse.BoolOf("value[i].isdecrementing")
    ls_V_modifiedonbehalfby_value = loo_JsonResponse.StringOf("value[i]._modifiedonbehalfby_value")
    li_Customersatisfactioncode = loo_JsonResponse.IntOf("value[i].customersatisfactioncode")
    ls_Stageid = loo_JsonResponse.StringOf("value[i].stageid")
    ls_V_kbarticleid_value = loo_JsonResponse.StringOf("value[i]._kbarticleid_value")
    ls_Entityimage_url = loo_JsonResponse.StringOf("value[i].entityimage_url")
    li_Firstresponsesent = loo_JsonResponse.BoolOf("value[i].firstresponsesent")
    li_Incidentstagecode = loo_JsonResponse.IntOf("value[i].incidentstagecode")
    ls_Customerid_accountAccountid = loo_JsonResponse.StringOf("value[i].customerid_account.accountid")
    ls_Customerid_accountName = loo_JsonResponse.StringOf("value[i].customerid_account.name")
    i = i + 1
loop


destroy loo_Rest
destroy loo_SbResponseBody
destroy loo_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"
      }
    }
  ]
}