phpExt / Creatio API / $top parameter
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$queryParams = new CkJsonObject();
$queryParams->UpdateString('$top','Value');
$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;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// 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"
// },
// {
// "Id": "0f5feb72-bcc8-4b0c-bace-1cf7d3ee7755",
// "CreatedOn": "2017-03-30T14:47:15Z",
// "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "ModifiedOn": "2017-03-31T07:41:38Z",
// "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "ProcessListeners": 0,
// "ContactId": "00e63875-323c-41a9-a795-e532e98d1563",
// "Name": "Symon Clarke",
// "OrgStructureUnitId": "ef696860-5b18-42cc-ae96-5fcb927b370a",
// "Notes": "",
// "JobId": "33f48df9-56e6-df11-971b-001d60e938c6",
// "FullJobTitle": "Marketing manager",
// "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "CareerStartDate": "2019-07-14T00: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": "82c5f81c-4018-44f1-8dcb-738704fd21c4"
// },
// {
// "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": "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
$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;
}
?>
Curl Command
curl -G -d "$top=Value"
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1
Postman Collection Item JSON
{
"name": "$top parameter",
"request": {
"method": "GET",
"header": [
{
"key": "ForceUseSession",
"type": "text",
"value": "true"
},
{
"key": "BPMCSRF",
"type": "text",
"value": "{{BPMCSRF}}"
}
],
"url": {
"raw": "{{BaseURI}}/0/odata/{{CollectionName1}}?$top={{Value}}",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}"
],
"query": [
{
"key": "$top",
"value": "{{Value}}"
}
]
},
"description": "Request for getting a set number of object collection instances via the [$top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_SystemQueryOptionstopandskip) parameter."
},
"response": [
{
"name": "[200] Gets a set number of object collection instances",
"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?$top=5",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee"
],
"query": [
{
"key": "$top",
"value": "5"
}
]
}
},
"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:51:12 GMT"
},
{
"key": "Content-Length",
"value": "4112"
}
],
"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 \"Id\": \"0f5feb72-bcc8-4b0c-bace-1cf7d3ee7755\",\n \"CreatedOn\": \"2017-03-30T14:47:15Z\",\n \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ModifiedOn\": \"2017-03-31T07:41:38Z\",\n \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ProcessListeners\": 0,\n \"ContactId\": \"00e63875-323c-41a9-a795-e532e98d1563\",\n \"Name\": \"Symon Clarke\",\n \"OrgStructureUnitId\": \"ef696860-5b18-42cc-ae96-5fcb927b370a\",\n \"Notes\": \"\",\n \"JobId\": \"33f48df9-56e6-df11-971b-001d60e938c6\",\n \"FullJobTitle\": \"Marketing manager\",\n \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"CareerStartDate\": \"2019-07-14T00: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\": \"82c5f81c-4018-44f1-8dcb-738704fd21c4\"\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\": \"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}"
}
]
}
