Chilkat Online Tools

phpAx / Salesforce Platform APIs / List event channels

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateString('q','SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel');

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://domain.com/services/data/v{{version}}/tooling/query/',$queryParams);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->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)

// {
//   "size": 2,
//   "totalSize": 2,
//   "done": true,
//   "queryLocator": null,
//   "entityTypeName": "PlatformEventChannel",
//   "records": [
//     {
//       "attributes": {
//         "type": "PlatformEventChannel",
//         "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE"
//       },
//       "Id": "0YL4H0000004C93WAE",
//       "DeveloperName": "HREvents",
//       "MasterLabel": "Custom Channel for the HR App",
//       "ChannelType": "data"
//     },
//     {
//       "attributes": {
//         "type": "PlatformEventChannel",
//         "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C98WAE"
//       },
//       "Id": "0YL4H0000004C98WAE",
//       "DeveloperName": "AdvocateEvents",
//       "MasterLabel": "Custom Channel for the HR App",
//       "ChannelType": "data"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$size = $jResp->IntOf('size');
$totalSize = $jResp->IntOf('totalSize');
$done = $jResp->BoolOf('done');
$queryLocator = $jResp->stringOf('queryLocator');
$entityTypeName = $jResp->stringOf('entityTypeName');
$i = 0;
$count_i = $jResp->SizeOfArray('records');
while ($i < $count_i) {
    $jResp->I = $i;
    $v_Type = $jResp->stringOf('records[i].attributes.type');
    $v_Url = $jResp->stringOf('records[i].attributes.url');
    $Id = $jResp->stringOf('records[i].Id');
    $DeveloperName = $jResp->stringOf('records[i].DeveloperName');
    $MasterLabel = $jResp->stringOf('records[i].MasterLabel');
    $ChannelType = $jResp->stringOf('records[i].ChannelType');
    $i = $i + 1;
}


?>

Curl Command

curl -G -d "q=SELECT%20Id,%20DeveloperName,%20MasterLabel,%20ChannelType%20FROM%20PlatformEventChannel"
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/

Postman Collection Item JSON

{
  "name": "List event channels",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "query",
        ""
      ],
      "query": [
        {
          "key": "q",
          "value": "SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel"
        }
      ]
    }
  },
  "response": [
    {
      "name": "List event channels",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "query",
            ""
          ],
          "query": [
            {
              "key": "q",
              "value": "SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 03 Jul 2023 13:15:17 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=7/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"size\": 2,\n    \"totalSize\": 2,\n    \"done\": true,\n    \"queryLocator\": null,\n    \"entityTypeName\": \"PlatformEventChannel\",\n    \"records\": [\n        {\n            \"attributes\": {\n                \"type\": \"PlatformEventChannel\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE\"\n            },\n            \"Id\": \"0YL4H0000004C93WAE\",\n            \"DeveloperName\": \"HREvents\",\n            \"MasterLabel\": \"Custom Channel for the HR App\",\n            \"ChannelType\": \"data\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"PlatformEventChannel\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C98WAE\"\n            },\n            \"Id\": \"0YL4H0000004C98WAE\",\n            \"DeveloperName\": \"AdvocateEvents\",\n            \"MasterLabel\": \"Custom Channel for the HR App\",\n            \"ChannelType\": \"data\"\n        }\n    ]\n}"
    }
  ]
}