Ruby / Creatio API / $filter parameter with startswith function
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("$filter","startswith(Field2,'Field2Value')")
http.SetRequestHeader("ForceUseSession","true")
http.SetRequestHeader("BPMCSRF","{{BPMCSRF}}")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "@odata.context": "https://myserver.com/0/odata/$metadata#Employee",
# "value": [
# {
# "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")
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
end
Curl Command
curl -G -d "$filter=startswith%28Field2,%27Field2Value%27%29"
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1
Postman Collection Item JSON
{
"name": "$filter parameter with startswith 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=startswith({{FieldName2}},'{{FieldName2Value2}}')",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}"
],
"query": [
{
"key": "$filter",
"value": "startswith({{FieldName2}},'{{FieldName2Value2}}')"
}
]
},
"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 the [startswith](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_startswith) function."
},
"response": [
{
"name": "[200] Gets filtered object collection instances. The filter uses the “startswith” function",
"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=startswith(FullJobTitle,'Custom')",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee"
],
"query": [
{
"key": "$filter",
"value": "startswith(FullJobTitle,'Custom')"
}
]
}
},
"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:52:52 GMT"
},
{
"key": "Content-Length",
"value": "1683"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee\",\n \"value\": [\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}"
}
]
}
