Chilkat Online Tools

Objective-C / Creatio API / $filter parameter with length function (lt operator)

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"$filter" value: @"length(Field2) lt Field2Value"];

[http SetRequestHeader: @"ForceUseSession" value: @"true"];
[http SetRequestHeader: @"BPMCSRF" value: @"{{BPMCSRF}}"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://myserver.com/0/odata/Collection1" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

// {
//   "@odata.context": "https://myserver.com/0/odata/$metadata#Employee",
//   "value": [
//     {
//       "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

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

NSString *odata_context = [jResp StringOf: @"\"@odata.context\""];
int i = 0;
int count_i = [[jResp SizeOfArray: @"value"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: 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=length%28Field2%29%20lt%20Field2Value"
	-H "ForceUseSession: true"
	-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1

Postman Collection Item JSON

{
  "name": "$filter parameter with length function (lt 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}}) lt {{FieldName2Value4}}",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "{{CollectionName1}}"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "length({{FieldName2}}) lt {{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 the lt operator."
  },
  "response": [
    {
      "name": "[200] Gets object collection instances; filter with the “lt” operator (length less than 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) lt 9",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "Employee"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "length(FullJobTitle) lt 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:17 GMT"
        },
        {
          "key": "Content-Length",
          "value": "868"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee\",\n    \"value\": [\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}"
    }
  ]
}