Chilkat Online Tools

phpAx / Support API / Show Many Custom Object Records

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';

$queryParams = new COM("Chilkat_9_5_0.JsonObject");
$queryParams->UpdateString('ids','<string>');
$queryParams->UpdateString('ids','<string>');

$http->SetRequestHeader('Accept','application/json');

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->QuickRequestParams('GET','https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/show_many',$queryParams);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);

$jResp = new COM("Chilkat_9_5_0.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)

// {
//   "count": "<integer>",
//   "custom_object_records": [
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "created_by_user_id": "<string>",
//       "custom_object_fields": {
//         "voluptate571": "<string>",
//         "aute_e": "<string>",
//         "nostrud_6f": "<string>"
//       },
//       "custom_object_key": "<string>",
//       "external_id": "<string>",
//       "id": "<string>",
//       "updated_at": "<dateTime>",
//       "updated_by_user_id": "<string>",
//       "url": "<string>"
//     },
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "created_by_user_id": "<string>",
//       "custom_object_fields": {
//         "eu4": "<string>"
//       },
//       "custom_object_key": "<string>",
//       "external_id": "<string>",
//       "id": "<string>",
//       "updated_at": "<dateTime>",
//       "updated_by_user_id": "<string>",
//       "url": "<string>"
//     }
//   ],
//   "next_page": "<string>",
//   "previous_page": "<string>"
// }

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

$count = $jResp->stringOf('count');
$next_page = $jResp->stringOf('next_page');
$previous_page = $jResp->stringOf('previous_page');
$i = 0;
$count_i = $jResp->SizeOfArray('custom_object_records');
while ($i < $count_i) {
    $jResp->I = $i;
    $name = $jResp->stringOf('custom_object_records[i].name');
    $created_at = $jResp->stringOf('custom_object_records[i].created_at');
    $created_by_user_id = $jResp->stringOf('custom_object_records[i].created_by_user_id');
    $Voluptate571 = $jResp->stringOf('custom_object_records[i].custom_object_fields.voluptate571');
    $Aute_e = $jResp->stringOf('custom_object_records[i].custom_object_fields.aute_e');
    $Nostrud_6f = $jResp->stringOf('custom_object_records[i].custom_object_fields.nostrud_6f');
    $custom_object_key = $jResp->stringOf('custom_object_records[i].custom_object_key');
    $external_id = $jResp->stringOf('custom_object_records[i].external_id');
    $id = $jResp->stringOf('custom_object_records[i].id');
    $updated_at = $jResp->stringOf('custom_object_records[i].updated_at');
    $updated_by_user_id = $jResp->stringOf('custom_object_records[i].updated_by_user_id');
    $url = $jResp->stringOf('custom_object_records[i].url');
    $Eu4 = $jResp->stringOf('custom_object_records[i].custom_object_fields.eu4');
    $i = $i + 1;
}


?>

Curl Command

curl  -u login:password -G -d "ids=%3Cstring%3E"
	-d "ids=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/show_many

Postman Collection Item JSON

{
  "name": "Show Many Custom Object Records",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/show_many?ids=<string>&ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "records",
        "show_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Array of ids to retieve"
        },
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Array of ids to retieve"
        }
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        }
      ]
    },
    "description": "List multiple custom object records by their ids\n#### Allowed For\n* Everyone"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/show_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "records",
            "show_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "(Required) Array of ids to retieve"
            }
          ],
          "variable": [
            {
              "key": "custom_object_key"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"custom_object_records\": [\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"custom_object_fields\": {\n        \"voluptate571\": \"<string>\",\n        \"aute_e\": \"<string>\",\n        \"nostrud_6f\": \"<string>\"\n      },\n      \"custom_object_key\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"custom_object_fields\": {\n        \"eu4\": \"<string>\"\n      },\n      \"custom_object_key\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ],\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}