Chilkat Online Tools

VB.NET / Creatio API / $filter parameter with length function (lt operator)

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("$filter","length(Field2) lt Field2Value")

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


Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",queryParams)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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



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

Dim odata_context As String = jResp.StringOf("""@odata.context""")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("value")
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")
    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
End While

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