Chilkat Online Tools

Swift / Creatio API / $filter parameter with contains function

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("$filter", value: "contains(Field2,'Field2Value')")

    http.SetRequestHeader("ForceUseSession", value: "true")
    http.SetRequestHeader("BPMCSRF", value: "{{BPMCSRF}}")

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://myserver.com/0/odata/Collection1", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "@odata.context": "https://myserver.com/0/odata/$metadata#Employee",
    //   "value": [
    //     {
    //       "Id": "0f5feb72-bcc8-4b0c-bace-1cf7d3ee7755",
    //       "CreatedOn": "2017-03-30T14:47:15Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T07:41:38Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "00e63875-323c-41a9-a795-e532e98d1563",
    //       "Name": "Symon Clarke",
    //       "OrgStructureUnitId": "ef696860-5b18-42cc-ae96-5fcb927b370a",
    //       "Notes": "",
    //       "JobId": "33f48df9-56e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "Marketing manager",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2019-07-14T00:00:00Z",
    //       "CareerDueDate": "0001-01-01T00:00:00Z",
    //       "ProbationDueDate": "0001-01-01T00:00:00Z",
    //       "ReasonForDismissalId": "00000000-0000-0000-0000-000000000000",
    //       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
    //       "ManagerId": "82c5f81c-4018-44f1-8dcb-738704fd21c4"
    //     },
    //     {
    //       "Id": "9842387d-069f-466c-9551-32cedbc16d90",
    //       "CreatedOn": "2017-03-30T14:50:30Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T07:27:18Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "cad50d15-f28d-49fc-aa79-21615ac35b86",
    //       "Name": "Mary King",
    //       "OrgStructureUnitId": "43172897-fbd6-4bc1-b81b-55964ab558e6",
    //       "Notes": "",
    //       "JobId": "955472f0-56e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "Customer manager",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2019-04-07T00:00:00Z",
    //       "CareerDueDate": "0001-01-01T00:00:00Z",
    //       "ProbationDueDate": "0001-01-01T00:00:00Z",
    //       "ReasonForDismissalId": "00000000-0000-0000-0000-000000000000",
    //       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
    //       "ManagerId": "e17c9cd6-262d-481d-86a9-f09a82984e0e"
    //     },
    //     {
    //       "Id": "3b952b60-2502-4ab2-a967-7f898f8b8b55",
    //       "CreatedOn": "2017-03-30T14:51:27Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T07:30:20Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "27bbc601-2d48-4652-8d18-eb93e718a78c",
    //       "Name": "Megan Lewis",
    //       "OrgStructureUnitId": "43172897-fbd6-4bc1-b81b-55964ab558e6",
    //       "Notes": "",
    //       "JobId": "955472f0-56e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "Customer manager",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2019-11-10T00:00:00Z",
    //       "CareerDueDate": "0001-01-01T00:00:00Z",
    //       "ProbationDueDate": "2020-02-10T00:00:00Z",
    //       "ReasonForDismissalId": "00000000-0000-0000-0000-000000000000",
    //       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
    //       "ManagerId": "e17c9cd6-262d-481d-86a9-f09a82984e0e"
    //     },
    //     {
    //       "Id": "cff2b81f-6f47-429a-acf8-fb751bd4575e",
    //       "CreatedOn": "2017-03-30T14:52:50Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T08:24:48Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "8b2c9fcc-8187-4197-b5fe-4acf4cc52475",
    //       "Name": "Tracy Wilkinson",
    //       "OrgStructureUnitId": "ef696860-5b18-42cc-ae96-5fcb927b370a",
    //       "Notes": "",
    //       "JobId": "33f48df9-56e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "Marketing manager",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2015-11-29T00:00:00Z",
    //       "CareerDueDate": "2019-07-08T00:00:00Z",
    //       "ProbationDueDate": "0001-01-01T00:00:00Z",
    //       "ReasonForDismissalId": "f83b228a-f36b-1410-b783-00155d04320c",
    //       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
    //       "ManagerId": "82c5f81c-4018-44f1-8dcb-738704fd21c4"
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Id: String?
    var CreatedOn: String?
    var CreatedById: String?
    var ModifiedOn: String?
    var ModifiedById: String?
    var ProcessListeners: Int
    var ContactId: String?
    var Name: String?
    var OrgStructureUnitId: String?
    var Notes: String?
    var JobId: String?
    var FullJobTitle: String?
    var OwnerId: String?
    var CareerStartDate: String?
    var CareerDueDate: String?
    var ProbationDueDate: String?
    var ReasonForDismissalId: String?
    var AccountId: String?
    var ManagerId: String?

    var odata_context: String? = jResp.StringOf("\"@odata.context\"")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("value").intValue
    while i < count_i {
        jResp.I = i
        Id = jResp.StringOf("value[i].Id")
        CreatedOn = jResp.StringOf("value[i].CreatedOn")
        CreatedById = jResp.StringOf("value[i].CreatedById")
        ModifiedOn = jResp.StringOf("value[i].ModifiedOn")
        ModifiedById = jResp.StringOf("value[i].ModifiedById")
        ProcessListeners = jResp.IntOf("value[i].ProcessListeners").intValue
        ContactId = jResp.StringOf("value[i].ContactId")
        Name = jResp.StringOf("value[i].Name")
        OrgStructureUnitId = jResp.StringOf("value[i].OrgStructureUnitId")
        Notes = jResp.StringOf("value[i].Notes")
        JobId = jResp.StringOf("value[i].JobId")
        FullJobTitle = jResp.StringOf("value[i].FullJobTitle")
        OwnerId = jResp.StringOf("value[i].OwnerId")
        CareerStartDate = jResp.StringOf("value[i].CareerStartDate")
        CareerDueDate = jResp.StringOf("value[i].CareerDueDate")
        ProbationDueDate = jResp.StringOf("value[i].ProbationDueDate")
        ReasonForDismissalId = jResp.StringOf("value[i].ReasonForDismissalId")
        AccountId = jResp.StringOf("value[i].AccountId")
        ManagerId = jResp.StringOf("value[i].ManagerId")
        i = i + 1
    }


}

Curl Command

curl -G -d "$filter=contains%28Field2,%27Field2Value%27%29"
	-H "ForceUseSession: true"
	-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1

Postman Collection Item JSON

{
  "name": "$filter parameter with contains function",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "ForceUseSession",
        "type": "text",
        "value": "true"
      },
      {
        "key": "BPMCSRF",
        "type": "text",
        "value": "{{BPMCSRF}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{BaseURI}}/0/odata/{{CollectionName1}}?$filter=contains({{FieldName2}},'{{FieldName2Value3}}')",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "{{CollectionName1}}"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "contains({{FieldName2}},'{{FieldName2Value3}}')"
        }
      ]
    },
    "description": "Request for getting filtered object collection instances via the [$filter](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_SystemQueryOptionfilter) parameter and the [contains](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_contains) function."
  },
  "response": [
    {
      "name": "[200] Gets filtered object collection instances that contain a specific value",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "type": "text",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "type": "text",
            "value": "application/json; charset=utf-8"
          },
          {
            "key": "ForceUseSession",
            "type": "text",
            "value": "true"
          },
          {
            "key": "BPMCSRF",
            "type": "text",
            "value": "{{BPMCSRF}}"
          }
        ],
        "url": {
          "raw": "https://myserver.com/0/odata/Employee?$filter=contains(FullJobTitle,'manager')",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "Employee"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "contains(FullJobTitle,'manager')"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Expires",
          "value": "-1"
        },
        {
          "key": "Server",
          "value": "Microsoft-IIS/10.0"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "X-AspNet-Version",
          "value": "4.0.30319"
        },
        {
          "key": "X-Powered-By",
          "value": "ASP.NET"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "Date",
          "value": "Wed, 26 Feb 2020 14:52:42 GMT"
        },
        {
          "key": "Content-Length",
          "value": "3298"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee\",\n    \"value\": [\n        {\n            \"Id\": \"0f5feb72-bcc8-4b0c-bace-1cf7d3ee7755\",\n            \"CreatedOn\": \"2017-03-30T14:47:15Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:41:38Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"00e63875-323c-41a9-a795-e532e98d1563\",\n            \"Name\": \"Symon Clarke\",\n            \"OrgStructureUnitId\": \"ef696860-5b18-42cc-ae96-5fcb927b370a\",\n            \"Notes\": \"\",\n            \"JobId\": \"33f48df9-56e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Marketing manager\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-07-14T00:00:00Z\",\n            \"CareerDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ProbationDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ReasonForDismissalId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n            \"ManagerId\": \"82c5f81c-4018-44f1-8dcb-738704fd21c4\"\n        },\n        {\n            \"Id\": \"9842387d-069f-466c-9551-32cedbc16d90\",\n            \"CreatedOn\": \"2017-03-30T14:50:30Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:27:18Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"cad50d15-f28d-49fc-aa79-21615ac35b86\",\n            \"Name\": \"Mary King\",\n            \"OrgStructureUnitId\": \"43172897-fbd6-4bc1-b81b-55964ab558e6\",\n            \"Notes\": \"\",\n            \"JobId\": \"955472f0-56e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Customer manager\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-04-07T00:00:00Z\",\n            \"CareerDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ProbationDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ReasonForDismissalId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n            \"ManagerId\": \"e17c9cd6-262d-481d-86a9-f09a82984e0e\"\n        },\n        {\n            \"Id\": \"3b952b60-2502-4ab2-a967-7f898f8b8b55\",\n            \"CreatedOn\": \"2017-03-30T14:51:27Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:30:20Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"27bbc601-2d48-4652-8d18-eb93e718a78c\",\n            \"Name\": \"Megan Lewis\",\n            \"OrgStructureUnitId\": \"43172897-fbd6-4bc1-b81b-55964ab558e6\",\n            \"Notes\": \"\",\n            \"JobId\": \"955472f0-56e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Customer manager\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-11-10T00:00:00Z\",\n            \"CareerDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ProbationDueDate\": \"2020-02-10T00:00:00Z\",\n            \"ReasonForDismissalId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n            \"ManagerId\": \"e17c9cd6-262d-481d-86a9-f09a82984e0e\"\n        },\n        {\n            \"Id\": \"cff2b81f-6f47-429a-acf8-fb751bd4575e\",\n            \"CreatedOn\": \"2017-03-30T14:52:50Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T08:24:48Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"8b2c9fcc-8187-4197-b5fe-4acf4cc52475\",\n            \"Name\": \"Tracy Wilkinson\",\n            \"OrgStructureUnitId\": \"ef696860-5b18-42cc-ae96-5fcb927b370a\",\n            \"Notes\": \"\",\n            \"JobId\": \"33f48df9-56e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Marketing manager\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2015-11-29T00:00:00Z\",\n            \"CareerDueDate\": \"2019-07-08T00:00:00Z\",\n            \"ProbationDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ReasonForDismissalId\": \"f83b228a-f36b-1410-b783-00155d04320c\",\n            \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n            \"ManagerId\": \"82c5f81c-4018-44f1-8dcb-738704fd21c4\"\n        }\n    ]\n}"
    }
  ]
}