.NET Core C# / Creatio API / $filter parameter (eq operator)
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.Http();
bool success;
Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("$filter","Field2 eq 'Field2Value'");
http.SetRequestHeader("ForceUseSession","true");
http.SetRequestHeader("BPMCSRF","{{BPMCSRF}}");
Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1",queryParams);
if (http.LastMethodSuccess == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(resp.Header);
Debug.WriteLine("Failed.");
return;
}
// 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
string Id;
string CreatedOn;
string CreatedById;
string ModifiedOn;
string ModifiedById;
int ProcessListeners;
string ContactId;
string Name;
string OrgStructureUnitId;
string Notes;
string JobId;
string FullJobTitle;
string OwnerId;
string CareerStartDate;
string CareerDueDate;
string ProbationDueDate;
string ReasonForDismissalId;
string AccountId;
string ManagerId;
string odata_context = jResp.StringOf("\"@odata.context\"");
int i = 0;
int count_i = jResp.SizeOfArray("value");
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;
}
Curl Command
curl -G -d "$filter=Field2%20eq%20%27Field2Value%27"
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1
Postman Collection Item JSON
{
"name": "$filter parameter (eq operator)",
"request": {
"method": "GET",
"header": [
{
"key": "ForceUseSession",
"type": "text",
"value": "true"
},
{
"key": "BPMCSRF",
"type": "text",
"value": "{{BPMCSRF}}"
}
],
"url": {
"raw": "{{BaseURI}}/0/odata/{{CollectionName1}}?$filter={{FieldName2}} eq '{{FieldName2Value1}}'",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}"
],
"query": [
{
"key": "$filter",
"value": "{{FieldName2}} eq '{{FieldName2Value1}}'"
}
]
},
"description": "Request for getting filtered objects 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 eq operator."
},
"response": [
{
"name": "[200] Gets filtered objects collection instances. The filter uses the “equal” operator",
"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 'Developer'",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee"
],
"query": [
{
"key": "$filter",
"value": "FullJobTitle eq 'Developer'"
}
]
}
},
"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:13 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}"
}
]
}
