Chilkat Online Tools

C++ / Creatio API / $filter parameter with length function (le operator)

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("$filter","length(Field2) le Field2Value");

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

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "@odata.context": "https://myserver.com/0/odata/$metadata#Employee",
    //   "value": [
    //     {
    //       "Id": "c31c7862-fe33-4a13-9bbc-0943fa08fd02",
    //       "CreatedOn": "2017-03-30T14:50:04Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2020-02-14T06:30:46.234Z",
    //       "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
    //       "ProcessListeners": 0,
    //       "ContactId": "227aab3b-7c0c-4181-abf9-81585563ab23",
    //       "Name": "William Walker",
    //       "OrgStructureUnitId": "d436a9ce-9690-4415-9e03-e8061d7cabb5",
    //       "Notes": "",
    //       "JobId": "11d68189-ced6-df11-9b2a-001d60e938c6",
    //       "FullJobTitle": "Developer",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2019-09-08T00:00:00Z",
    //       "CareerDueDate": "0001-01-01T00:00:00Z",
    //       "ProbationDueDate": "2020-01-09T00:00:00Z",
    //       "ReasonForDismissalId": "00000000-0000-0000-0000-000000000000",
    //       "AccountId": "a0bf3e92-f36b-1410-0499-00155d043204",
    //       "ManagerId": "3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb"
    //     },
    //     {
    //       "Id": "ddb34ecb-f009-484a-ad2b-0a49a475bdb2",
    //       "CreatedOn": "2017-03-30T14:54:20Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T07:49:14Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "3822fb63-0e78-416f-a06b-3d18bd5e0448",
    //       "Name": "Timothy Sawyer",
    //       "OrgStructureUnitId": "d436a9ce-9690-4415-9e03-e8061d7cabb5",
    //       "Notes": "",
    //       "JobId": "11d68189-ced6-df11-9b2a-001d60e938c6",
    //       "FullJobTitle": "Developer",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2016-12-04T00:00:00Z",
    //       "CareerDueDate": "2019-10-08T00:00:00Z",
    //       "ProbationDueDate": "0001-01-01T00:00:00Z",
    //       "ReasonForDismissalId": "f83b228a-f36b-1410-b783-00155d04320c",
    //       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
    //       "ManagerId": "3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb"
    //     },
    //     {
    //       "Id": "26fffdc9-a184-47a7-a6b6-cafc9fe58327",
    //       "CreatedOn": "2017-03-30T14:40:18Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T07:05:59Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "8f9b52f9-b494-4642-8563-25d706f2d5db",
    //       "Name": "Caleb Jones",
    //       "OrgStructureUnitId": "b3cf526e-4427-4daa-91a6-19411ddabacd",
    //       "Notes": "",
    //       "JobId": "34f48df9-56e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "CEO",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2017-12-10T00: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": "00000000-0000-0000-0000-000000000000"
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *Id = 0;
    const char *CreatedOn = 0;
    const char *CreatedById = 0;
    const char *ModifiedOn = 0;
    const char *ModifiedById = 0;
    int ProcessListeners;
    const char *ContactId = 0;
    const char *Name = 0;
    const char *OrgStructureUnitId = 0;
    const char *Notes = 0;
    const char *JobId = 0;
    const char *FullJobTitle = 0;
    const char *OwnerId = 0;
    const char *CareerStartDate = 0;
    const char *CareerDueDate = 0;
    const char *ProbationDueDate = 0;
    const char *ReasonForDismissalId = 0;
    const char *AccountId = 0;
    const char *ManagerId = 0;

    const char *odata_context = jResp.stringOf("\"@odata.context\"");
    int i = 0;
    int count_i = jResp.SizeOfArray("value");
    while (i < count_i) {
        jResp.put_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");
        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=length%28Field2%29%20le%20Field2Value"
	-H "ForceUseSession: true"
	-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1

Postman Collection Item JSON

{
  "name": "$filter parameter with length function (le operator)",
  "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=length({{FieldName2}}) le {{FieldName2Value4}}",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "{{CollectionName1}}"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "length({{FieldName2}}) le {{FieldName2Value4}}"
        }
      ]
    },
    "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 [length](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_length) function with le operator."
  },
  "response": [
    {
      "name": "[200] Gets object collection instances; filter with the “le” operator (length is less or equal to a set 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=length(FullJobTitle) le 9",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "Employee"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "length(FullJobTitle) le 9"
            }
          ]
        }
      },
      "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:54:28 GMT"
        },
        {
          "key": "Content-Length",
          "value": "2472"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee\",\n    \"value\": [\n        {\n            \"Id\": \"c31c7862-fe33-4a13-9bbc-0943fa08fd02\",\n            \"CreatedOn\": \"2017-03-30T14:50:04Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2020-02-14T06:30:46.234Z\",\n            \"ModifiedById\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"227aab3b-7c0c-4181-abf9-81585563ab23\",\n            \"Name\": \"William Walker\",\n            \"OrgStructureUnitId\": \"d436a9ce-9690-4415-9e03-e8061d7cabb5\",\n            \"Notes\": \"\",\n            \"JobId\": \"11d68189-ced6-df11-9b2a-001d60e938c6\",\n            \"FullJobTitle\": \"Developer\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-09-08T00:00:00Z\",\n            \"CareerDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ProbationDueDate\": \"2020-01-09T00:00:00Z\",\n            \"ReasonForDismissalId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"a0bf3e92-f36b-1410-0499-00155d043204\",\n            \"ManagerId\": \"3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb\"\n        },\n        {\n            \"Id\": \"ddb34ecb-f009-484a-ad2b-0a49a475bdb2\",\n            \"CreatedOn\": \"2017-03-30T14:54:20Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:49:14Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"3822fb63-0e78-416f-a06b-3d18bd5e0448\",\n            \"Name\": \"Timothy Sawyer\",\n            \"OrgStructureUnitId\": \"d436a9ce-9690-4415-9e03-e8061d7cabb5\",\n            \"Notes\": \"\",\n            \"JobId\": \"11d68189-ced6-df11-9b2a-001d60e938c6\",\n            \"FullJobTitle\": \"Developer\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2016-12-04T00:00:00Z\",\n            \"CareerDueDate\": \"2019-10-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\": \"3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb\"\n        },\n        {\n            \"Id\": \"26fffdc9-a184-47a7-a6b6-cafc9fe58327\",\n            \"CreatedOn\": \"2017-03-30T14:40:18Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:05:59Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"8f9b52f9-b494-4642-8563-25d706f2d5db\",\n            \"Name\": \"Caleb Jones\",\n            \"OrgStructureUnitId\": \"b3cf526e-4427-4daa-91a6-19411ddabacd\",\n            \"Notes\": \"\",\n            \"JobId\": \"34f48df9-56e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"CEO\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2017-12-10T00: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\": \"00000000-0000-0000-0000-000000000000\"\n        }\n    ]\n}"
    }
  ]
}