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

Swift Example

func chilkatTest() {
    let rest = CkoRest()
    var success: Bool

    //  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/tasks
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.Connect("my-dynamics-domain.api.crm.dynamics.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)
    if success != true {
        print("ConnectFailReason: \(rest.ConnectFailReason.intValue)")
        print("\(rest.LastErrorText)")
        return
    }

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

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

    let sbResponseBody = CkoStringBuilder()
    success = rest.FullRequestNoBodySb("GET", uriPath: "/api/data/v9.0/tasks", sb: sbResponseBody)
    if success != true {
        print("\(rest.LastErrorText)")
        return
    }

    var respStatusCode: Int = rest.ResponseStatusCode.intValue
    if respStatusCode >= 400 {
        print("Response Status Code = \(respStatusCode)")
        print("Response Header:")
        print("\(rest.ResponseHeader)")
        print("Response Body:")
        print("\(sbResponseBody.GetAsString())")
        return
    }

    let jsonResponse = CkoJsonObject()
    jsonResponse.LoadSb(sbResponseBody)

    var i: Int
    var count_i: Int

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


}

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