Chilkat Online Tools

phpExt / Creatio API / $select 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('$select','Field1,Field2');

$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(Name,FullJobTitle)",
//   "value": [
//     {
//       "Name": "William Walker",
//       "FullJobTitle": "Developer"
//     },
//     {
//       "Name": "Timothy Sawyer",
//       "FullJobTitle": "Developer"
//     },
//     {
//       "Name": "Symon Clarke",
//       "FullJobTitle": "Marketing manager"
//     },
//     {
//       "Name": "Mary King",
//       "FullJobTitle": "Customer manager"
//     },
//     {
//       "Name": "Sarah M. Richards",
//       "FullJobTitle": "Head of accounting department"
//     },
//     {
//       "Name": "Valerie E. Murphy",
//       "FullJobTitle": "Head of marketing department"
//     },
//     {
//       "Name": "Jason Robinson",
//       "FullJobTitle": "Specialist"
//     },
//     {
//       "Name": "Megan Lewis",
//       "FullJobTitle": "Customer manager"
//     },
//     {
//       "Name": "Peter Moore",
//       "FullJobTitle": "Head of development department"
//     },
//     {
//       "Name": "Caleb Jones",
//       "FullJobTitle": "CEO"
//     },
//     {
//       "Name": "John Best",
//       "FullJobTitle": "Head of sales department"
//     },
//     {
//       "Name": "Tiffany J. Martin",
//       "FullJobTitle": "IT Support Engineer"
//     },
//     {
//       "Name": "Tracy Wilkinson",
//       "FullJobTitle": "Marketing manager"
//     }
//   ]
// }

// 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);
    $Name = $jResp->stringOf('value[i].Name');
    $FullJobTitle = $jResp->stringOf('value[i].FullJobTitle');
    $i = $i + 1;
}


?>

Curl Command

curl -G -d "$select=Field1,Field2"
	-H "ForceUseSession: true"
	-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1

Postman Collection Item JSON

{
  "name": "$select parameter",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "ForceUseSession",
        "type": "text",
        "value": "true"
      },
      {
        "key": "BPMCSRF",
        "type": "text",
        "value": "{{BPMCSRF}}"
      }
    ],
    "url": {
      "raw": "{{BaseURI}}/0/odata/{{CollectionName1}}?$select={{FieldName1}},{{FieldName2}}",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "{{CollectionName1}}"
      ],
      "query": [
        {
          "key": "$select",
          "value": "{{FieldName1}},{{FieldName2}}"
        }
      ]
    },
    "description": "Request for getting specific fields from an object collection instances via the [$select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_SystemQueryOptionselect) parameter."
  },
  "response": [
    {
      "name": "[200] Gets object collection instances with selected fields",
      "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?$select=Name,FullJobTitle",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "Employee"
          ],
          "query": [
            {
              "key": "$select",
              "value": "Name,FullJobTitle"
            }
          ]
        }
      },
      "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:34 GMT"
        },
        {
          "key": "Content-Length",
          "value": "884"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee(Name,FullJobTitle)\",\n    \"value\": [\n        {\n            \"Name\": \"William Walker\",\n            \"FullJobTitle\": \"Developer\"\n        },\n        {\n            \"Name\": \"Timothy Sawyer\",\n            \"FullJobTitle\": \"Developer\"\n        },\n        {\n            \"Name\": \"Symon Clarke\",\n            \"FullJobTitle\": \"Marketing manager\"\n        },\n        {\n            \"Name\": \"Mary King\",\n            \"FullJobTitle\": \"Customer manager\"\n        },\n        {\n            \"Name\": \"Sarah M. Richards\",\n            \"FullJobTitle\": \"Head of accounting department\"\n        },\n        {\n            \"Name\": \"Valerie E. Murphy\",\n            \"FullJobTitle\": \"Head of marketing department\"\n        },\n        {\n            \"Name\": \"Jason Robinson\",\n            \"FullJobTitle\": \"Specialist\"\n        },\n        {\n            \"Name\": \"Megan Lewis\",\n            \"FullJobTitle\": \"Customer manager\"\n        },\n        {\n            \"Name\": \"Peter Moore\",\n            \"FullJobTitle\": \"Head of development department\"\n        },\n        {\n            \"Name\": \"Caleb Jones\",\n            \"FullJobTitle\": \"CEO\"\n        },\n        {\n            \"Name\": \"John Best\",\n            \"FullJobTitle\": \"Head of sales department\"\n        },\n        {\n            \"Name\": \"Tiffany J. Martin\",\n            \"FullJobTitle\": \"IT Support Engineer\"\n        },\n        {\n            \"Name\": \"Tracy Wilkinson\",\n            \"FullJobTitle\": \"Marketing manager\"\n        }\n    ]\n}"
    }
  ]
}