Chilkat Online Tools

Android / Creatio API / $filter parameter with length function (gt operator)

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("$filter","length(Field2) gt 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) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

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

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "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": "f11df686-a557-4790-99e5-36ec8dcd2f00",
    //       "CreatedOn": "2017-03-30T14:24:32Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T07:37:37Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "f1edc225-4312-45e9-90fb-a63edbe9294f",
    //       "Name": "Sarah M. Richards",
    //       "OrgStructureUnitId": "60c294d4-b4f7-4809-b061-1e8016264edc",
    //       "Notes": "",
    //       "JobId": "ca49a603-57e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "Head of accounting department",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2019-01-08T00: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": "26fffdc9-a184-47a7-a6b6-cafc9fe58327"
    //     },
    //     {
    //       "Id": "82c5f81c-4018-44f1-8dcb-738704fd21c4",
    //       "CreatedOn": "2017-03-30T13:33:04Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T08:31:29Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "c38d46fd-e405-491a-a508-01bb9760eecc",
    //       "Name": "Valerie E. Murphy",
    //       "OrgStructureUnitId": "ef696860-5b18-42cc-ae96-5fcb927b370a",
    //       "Notes": "",
    //       "JobId": "ca49a603-57e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "Head of marketing department",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2019-02-03T00: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": "26fffdc9-a184-47a7-a6b6-cafc9fe58327"
    //     },
    //     {
    //       "Id": "3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb",
    //       "CreatedOn": "2017-03-30T14:35:03Z",
    //       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ModifiedOn": "2017-03-31T07:32:45Z",
    //       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "ProcessListeners": 0,
    //       "ContactId": "8850d33c-b783-45dc-a86c-5d29f9e7c03a",
    //       "Name": "Peter Moore",
    //       "OrgStructureUnitId": "d436a9ce-9690-4415-9e03-e8061d7cabb5",
    //       "Notes": "",
    //       "JobId": "ca49a603-57e6-df11-971b-001d60e938c6",
    //       "FullJobTitle": "Head of development department",
    //       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    //       "CareerStartDate": "2019-11-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": "26fffdc9-a184-47a7-a6b6-cafc9fe58327"
    //     }
    //   ]
    // }

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

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

    String 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;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "$filter parameter with length function (gt 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}}) gt {{FieldName2Value5}}",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "{{CollectionName1}}"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "length({{FieldName2}}) gt {{FieldName2Value5}}"
        }
      ]
    },
    "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 gt operator."
  },
  "response": [
    {
      "name": "[200] Gets object collection instances; filter with the “gt” operator (length is greater that 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) gt 25",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "Employee"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "length(FullJobTitle) gt 25"
            }
          ]
        }
      },
      "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:53:52 GMT"
        },
        {
          "key": "Content-Length",
          "value": "2540"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee\",\n    \"value\": [\n        {\n            \"Id\": \"f11df686-a557-4790-99e5-36ec8dcd2f00\",\n            \"CreatedOn\": \"2017-03-30T14:24:32Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:37:37Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"f1edc225-4312-45e9-90fb-a63edbe9294f\",\n            \"Name\": \"Sarah M. Richards\",\n            \"OrgStructureUnitId\": \"60c294d4-b4f7-4809-b061-1e8016264edc\",\n            \"Notes\": \"\",\n            \"JobId\": \"ca49a603-57e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Head of accounting department\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-01-08T00: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\": \"26fffdc9-a184-47a7-a6b6-cafc9fe58327\"\n        },\n        {\n            \"Id\": \"82c5f81c-4018-44f1-8dcb-738704fd21c4\",\n            \"CreatedOn\": \"2017-03-30T13:33:04Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T08:31:29Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"c38d46fd-e405-491a-a508-01bb9760eecc\",\n            \"Name\": \"Valerie E. Murphy\",\n            \"OrgStructureUnitId\": \"ef696860-5b18-42cc-ae96-5fcb927b370a\",\n            \"Notes\": \"\",\n            \"JobId\": \"ca49a603-57e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Head of marketing department\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-02-03T00: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\": \"26fffdc9-a184-47a7-a6b6-cafc9fe58327\"\n        },\n        {\n            \"Id\": \"3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb\",\n            \"CreatedOn\": \"2017-03-30T14:35:03Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:32:45Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"8850d33c-b783-45dc-a86c-5d29f9e7c03a\",\n            \"Name\": \"Peter Moore\",\n            \"OrgStructureUnitId\": \"d436a9ce-9690-4415-9e03-e8061d7cabb5\",\n            \"Notes\": \"\",\n            \"JobId\": \"ca49a603-57e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Head of development department\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-11-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\": \"26fffdc9-a184-47a7-a6b6-cafc9fe58327\"\n        }\n    ]\n}"
    }
  ]
}