Chilkat Online Tools

VBScript / Creatio API / $filter parameter (eq operators) with OR logical function

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("$filter","Field2 eq 'Field2Value' or Collection2/Field1 eq 'Field1Value'")

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

' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",queryParams)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

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

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

    WScript.Quit
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": "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": "9842387d-069f-466c-9551-32cedbc16d90",
'       "CreatedOn": "2017-03-30T14:50:30Z",
'       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
'       "ModifiedOn": "2017-03-31T07:27:18Z",
'       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
'       "ProcessListeners": 0,
'       "ContactId": "cad50d15-f28d-49fc-aa79-21615ac35b86",
'       "Name": "Mary King",
'       "OrgStructureUnitId": "43172897-fbd6-4bc1-b81b-55964ab558e6",
'       "Notes": "",
'       "JobId": "955472f0-56e6-df11-971b-001d60e938c6",
'       "FullJobTitle": "Customer manager",
'       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
'       "CareerStartDate": "2019-04-07T00: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": "e17c9cd6-262d-481d-86a9-f09a82984e0e"
'     },
'     {
'       "Id": "3b952b60-2502-4ab2-a967-7f898f8b8b55",
'       "CreatedOn": "2017-03-30T14:51:27Z",
'       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
'       "ModifiedOn": "2017-03-31T07:30:20Z",
'       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
'       "ProcessListeners": 0,
'       "ContactId": "27bbc601-2d48-4652-8d18-eb93e718a78c",
'       "Name": "Megan Lewis",
'       "OrgStructureUnitId": "43172897-fbd6-4bc1-b81b-55964ab558e6",
'       "Notes": "",
'       "JobId": "955472f0-56e6-df11-971b-001d60e938c6",
'       "FullJobTitle": "Customer manager",
'       "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
'       "CareerStartDate": "2019-11-10T00:00:00Z",
'       "CareerDueDate": "0001-01-01T00:00:00Z",
'       "ProbationDueDate": "2020-02-10T00:00:00Z",
'       "ReasonForDismissalId": "00000000-0000-0000-0000-000000000000",
'       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
'       "ManagerId": "e17c9cd6-262d-481d-86a9-f09a82984e0e"
'     }
'   ]
' }

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

odata_context = jResp.StringOf("""@odata.context""")
i = 0
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

outFile.Close

Curl Command

curl -G -d "$filter=Field2%20eq%20%27Field2Value%27%20or%20Collection2%2FField1%20eq%20%27Field1Value%27"
	-H "ForceUseSession: true"
	-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1

Postman Collection Item JSON

{
  "name": "$filter parameter (eq operators) with OR logical function",
  "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={{FieldName2}} eq '{{FieldName2Value7}}' or {{CollectionName2}}/{{FieldName1}} eq '{{FieldName1Value2}}'",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "{{CollectionName1}}"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "{{FieldName2}} eq '{{FieldName2Value7}}' or {{CollectionName2}}/{{FieldName1}} eq '{{FieldName1Value2}}'"
        }
      ]
    },
    "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 with [OR](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_Or) logical function."
  },
  "response": [
    {
      "name": "[200] Gets filtered object collection instances. At least one of the alternative filter conditions must be met",
      "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=FullJobTitle eq 'Customer manager' or Account/Name eq 'XT Group'",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "Employee"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "FullJobTitle eq 'Customer manager' or Account/Name eq 'XT Group'"
            }
          ]
        }
      },
      "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": "Fri, 06 Mar 2020 06:20:06 GMT"
        },
        {
          "key": "Content-Length",
          "value": "2487"
        }
      ],
      "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\": \"9842387d-069f-466c-9551-32cedbc16d90\",\n            \"CreatedOn\": \"2017-03-30T14:50:30Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:27:18Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"cad50d15-f28d-49fc-aa79-21615ac35b86\",\n            \"Name\": \"Mary King\",\n            \"OrgStructureUnitId\": \"43172897-fbd6-4bc1-b81b-55964ab558e6\",\n            \"Notes\": \"\",\n            \"JobId\": \"955472f0-56e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Customer manager\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-04-07T00: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\": \"e17c9cd6-262d-481d-86a9-f09a82984e0e\"\n        },\n        {\n            \"Id\": \"3b952b60-2502-4ab2-a967-7f898f8b8b55\",\n            \"CreatedOn\": \"2017-03-30T14:51:27Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2017-03-31T07:30:20Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"ContactId\": \"27bbc601-2d48-4652-8d18-eb93e718a78c\",\n            \"Name\": \"Megan Lewis\",\n            \"OrgStructureUnitId\": \"43172897-fbd6-4bc1-b81b-55964ab558e6\",\n            \"Notes\": \"\",\n            \"JobId\": \"955472f0-56e6-df11-971b-001d60e938c6\",\n            \"FullJobTitle\": \"Customer manager\",\n            \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"CareerStartDate\": \"2019-11-10T00:00:00Z\",\n            \"CareerDueDate\": \"0001-01-01T00:00:00Z\",\n            \"ProbationDueDate\": \"2020-02-10T00:00:00Z\",\n            \"ReasonForDismissalId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n            \"ManagerId\": \"e17c9cd6-262d-481d-86a9-f09a82984e0e\"\n        }\n    ]\n}"
    }
  ]
}