Foxpro / Creatio API / $filter parameter with day function (eq operator)
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcCreatedOn
LOCAL lcCreatedById
LOCAL lcModifiedOn
LOCAL lcModifiedById
LOCAL lnProcessListeners
LOCAL lcContactId
LOCAL lcName
LOCAL lcOrgStructureUnitId
LOCAL lcNotes
LOCAL lcJobId
LOCAL lcFullJobTitle
LOCAL lcOwnerId
LOCAL lcCareerStartDate
LOCAL lcCareerDueDate
LOCAL lcProbationDueDate
LOCAL lcReasonForDismissalId
LOCAL lcAccountId
LOCAL lcManagerId
LOCAL lcOdata_context
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("$filter","day(Field3) eq Field3Value")
loHttp.SetRequestHeader("ForceUseSession","true")
loHttp.SetRequestHeader("BPMCSRF","{{BPMCSRF}}")
loResp = loHttp.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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": "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"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcOdata_context = loJResp.StringOf('"@odata.context"')
i = 0
lnCount_i = loJResp.SizeOfArray("value")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("value[i].Id")
lcCreatedOn = loJResp.StringOf("value[i].CreatedOn")
lcCreatedById = loJResp.StringOf("value[i].CreatedById")
lcModifiedOn = loJResp.StringOf("value[i].ModifiedOn")
lcModifiedById = loJResp.StringOf("value[i].ModifiedById")
lnProcessListeners = loJResp.IntOf("value[i].ProcessListeners")
lcContactId = loJResp.StringOf("value[i].ContactId")
lcName = loJResp.StringOf("value[i].Name")
lcOrgStructureUnitId = loJResp.StringOf("value[i].OrgStructureUnitId")
lcNotes = loJResp.StringOf("value[i].Notes")
lcJobId = loJResp.StringOf("value[i].JobId")
lcFullJobTitle = loJResp.StringOf("value[i].FullJobTitle")
lcOwnerId = loJResp.StringOf("value[i].OwnerId")
lcCareerStartDate = loJResp.StringOf("value[i].CareerStartDate")
lcCareerDueDate = loJResp.StringOf("value[i].CareerDueDate")
lcProbationDueDate = loJResp.StringOf("value[i].ProbationDueDate")
lcReasonForDismissalId = loJResp.StringOf("value[i].ReasonForDismissalId")
lcAccountId = loJResp.StringOf("value[i].AccountId")
lcManagerId = loJResp.StringOf("value[i].ManagerId")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "$filter=day%28Field3%29%20eq%20Field3Value"
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1
Postman Collection Item JSON
{
"name": "$filter parameter with day 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=day({{FieldName3}}) eq {{FieldName3Value1}}",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}"
],
"query": [
{
"key": "$filter",
"value": "day({{FieldName3}}) eq {{FieldName3Value1}}"
}
]
},
"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 using the [day](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_day) function."
},
"response": [
{
"name": "[200] Gets object collection instances; filter with the “eq” operator (day 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=day(CareerStartDate) eq 8",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee"
],
"query": [
{
"key": "$filter",
"value": "day(CareerStartDate) eq 8"
}
]
}
},
"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:15 GMT"
},
{
"key": "Content-Length",
"value": "1704"
}
],
"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\": \"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}"
}
]
}
