PowerBuilder / Creatio API / $filter parameter with length function (eq operator)
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_CreatedOn
string ls_CreatedById
string ls_ModifiedOn
string ls_ModifiedById
integer li_ProcessListeners
string ls_ContactId
string ls_Name
string ls_OrgStructureUnitId
string ls_Notes
string ls_JobId
string ls_FullJobTitle
string ls_OwnerId
string ls_CareerStartDate
string ls_CareerDueDate
string ls_ProbationDueDate
string ls_ReasonForDismissalId
string ls_AccountId
string ls_ManagerId
string ls_Odata_context
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("$filter","length(Field2) eq Field2Value")
loo_Http.SetRequestHeader("ForceUseSession","true")
loo_Http.SetRequestHeader("BPMCSRF","{{BPMCSRF}}")
loo_Resp = loo_Http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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": "ddb34ecb-f009-484a-ad2b-0a49a475bdb2",
// "CreatedOn": "2017-03-30T14:54:20Z",
// "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "ModifiedOn": "2017-03-31T07:49:14Z",
// "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "ProcessListeners": 0,
// "ContactId": "3822fb63-0e78-416f-a06b-3d18bd5e0448",
// "Name": "Timothy Sawyer",
// "OrgStructureUnitId": "d436a9ce-9690-4415-9e03-e8061d7cabb5",
// "Notes": "",
// "JobId": "11d68189-ced6-df11-9b2a-001d60e938c6",
// "FullJobTitle": "Developer",
// "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "CareerStartDate": "2016-12-04T00:00:00Z",
// "CareerDueDate": "2019-10-08T00:00:00Z",
// "ProbationDueDate": "0001-01-01T00:00:00Z",
// "ReasonForDismissalId": "f83b228a-f36b-1410-b783-00155d04320c",
// "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
// "ManagerId": "3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Odata_context = loo_JResp.StringOf("~"@odata.context~"")
i = 0
li_Count_i = loo_JResp.SizeOfArray("value")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("value[i].Id")
ls_CreatedOn = loo_JResp.StringOf("value[i].CreatedOn")
ls_CreatedById = loo_JResp.StringOf("value[i].CreatedById")
ls_ModifiedOn = loo_JResp.StringOf("value[i].ModifiedOn")
ls_ModifiedById = loo_JResp.StringOf("value[i].ModifiedById")
li_ProcessListeners = loo_JResp.IntOf("value[i].ProcessListeners")
ls_ContactId = loo_JResp.StringOf("value[i].ContactId")
ls_Name = loo_JResp.StringOf("value[i].Name")
ls_OrgStructureUnitId = loo_JResp.StringOf("value[i].OrgStructureUnitId")
ls_Notes = loo_JResp.StringOf("value[i].Notes")
ls_JobId = loo_JResp.StringOf("value[i].JobId")
ls_FullJobTitle = loo_JResp.StringOf("value[i].FullJobTitle")
ls_OwnerId = loo_JResp.StringOf("value[i].OwnerId")
ls_CareerStartDate = loo_JResp.StringOf("value[i].CareerStartDate")
ls_CareerDueDate = loo_JResp.StringOf("value[i].CareerDueDate")
ls_ProbationDueDate = loo_JResp.StringOf("value[i].ProbationDueDate")
ls_ReasonForDismissalId = loo_JResp.StringOf("value[i].ReasonForDismissalId")
ls_AccountId = loo_JResp.StringOf("value[i].AccountId")
ls_ManagerId = loo_JResp.StringOf("value[i].ManagerId")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "$filter=length%28Field2%29%20eq%20Field2Value"
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1
Postman Collection Item JSON
{
"name": "$filter parameter with length function (eq 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}}) eq {{FieldName2Value4}}",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}"
],
"query": [
{
"key": "$filter",
"value": "length({{FieldName2}}) eq {{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 eq operator."
},
"response": [
{
"name": "[200] Gets object collection instances; filter with the “eq” operator (length 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) eq 9",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee"
],
"query": [
{
"key": "$filter",
"value": "length(FullJobTitle) eq 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:53:30 GMT"
},
{
"key": "Content-Length",
"value": "1681"
}
],
"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\": \"ddb34ecb-f009-484a-ad2b-0a49a475bdb2\",\n \"CreatedOn\": \"2017-03-30T14:54:20Z\",\n \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ModifiedOn\": \"2017-03-31T07:49:14Z\",\n \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ProcessListeners\": 0,\n \"ContactId\": \"3822fb63-0e78-416f-a06b-3d18bd5e0448\",\n \"Name\": \"Timothy Sawyer\",\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\": \"2016-12-04T00:00:00Z\",\n \"CareerDueDate\": \"2019-10-08T00:00:00Z\",\n \"ProbationDueDate\": \"0001-01-01T00:00:00Z\",\n \"ReasonForDismissalId\": \"f83b228a-f36b-1410-b783-00155d04320c\",\n \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n \"ManagerId\": \"3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb\"\n }\n ]\n}"
}
]
}
