VB6 / Creatio API / $filter parameter with length function (ge 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 ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("$filter","length(Field2) ge Field2Value")
http.SetRequestHeader "ForceUseSession","true"
http.SetRequestHeader "BPMCSRF","{{BPMCSRF}}"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "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": "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"
' },
' {
' "Id": "e17c9cd6-262d-481d-86a9-f09a82984e0e",
' "CreatedOn": "2017-03-30T10:40:39Z",
' "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
' "ModifiedOn": "2017-03-31T07:25:48Z",
' "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
' "ProcessListeners": 0,
' "ContactId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
' "Name": "John Best",
' "OrgStructureUnitId": "43172897-fbd6-4bc1-b81b-55964ab558e6",
' "Notes": "",
' "JobId": "ca49a603-57e6-df11-971b-001d60e938c6",
' "FullJobTitle": "Head of sales department",
' "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
' "CareerStartDate": "2018-02-11T00: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
Dim Id As String
Dim CreatedOn As String
Dim CreatedById As String
Dim ModifiedOn As String
Dim ModifiedById As String
Dim ProcessListeners As Long
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
odata_context = jResp.StringOf("""@odata.context""")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("value")
Do 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
Loop
Curl Command
curl -G -d "$filter=length%28Field2%29%20ge%20Field2Value"
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1
Postman Collection Item JSON
{
"name": "$filter parameter with length function (ge 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}}) ge {{FieldName2Value6}}",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}"
],
"query": [
{
"key": "$filter",
"value": "length({{FieldName2}}) ge {{FieldName2Value6}}"
}
]
},
"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 ge operator."
},
"response": [
{
"name": "[200] Gets object collection instances; filter with the “ge” operator (length is greater or equals 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) ge 24",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee"
],
"query": [
{
"key": "$filter",
"value": "length(FullJobTitle) ge 24"
}
]
}
},
"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:02 GMT"
},
{
"key": "Content-Length",
"value": "3350"
}
],
"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 \"Id\": \"e17c9cd6-262d-481d-86a9-f09a82984e0e\",\n \"CreatedOn\": \"2017-03-30T10:40:39Z\",\n \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ModifiedOn\": \"2017-03-31T07:25:48Z\",\n \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ProcessListeners\": 0,\n \"ContactId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"Name\": \"John Best\",\n \"OrgStructureUnitId\": \"43172897-fbd6-4bc1-b81b-55964ab558e6\",\n \"Notes\": \"\",\n \"JobId\": \"ca49a603-57e6-df11-971b-001d60e938c6\",\n \"FullJobTitle\": \"Head of sales department\",\n \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"CareerStartDate\": \"2018-02-11T00: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}"
}
]
}
