Chilkat Online Tools

phpExt / Support API / Show Trigger Revision

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();

$http->put_BasicAuth(true);
$http->put_Login('login');
$http->put_Password('password');

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

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/triggers/:trigger_id/revisions/:trigger_revision_id',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

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

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "trigger_revision": {
//     "author_id": "<integer>",
//     "created_at": "<string>",
//     "id": "<integer>",
//     "snapshot": {
//       "actions": [
//         {
//           "field": "<string>",
//           "value": "<string>"
//         },
//         {
//           "field": "<string>",
//           "value": "<string>"
//         }
//       ],
//       "active": "<boolean>",
//       "conditions": {
//         "all": [
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           }
//         ],
//         "any": [
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           }
//         ]
//       },
//       "description": "<string>",
//       "title": "<string>"
//     },
//     "url": "<string>"
//   }
// }

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

$Author_id = $jResp->stringOf('trigger_revision.author_id');
$Created_at = $jResp->stringOf('trigger_revision.created_at');
$Id = $jResp->stringOf('trigger_revision.id');
$Active = $jResp->stringOf('trigger_revision.snapshot.active');
$Description = $jResp->stringOf('trigger_revision.snapshot.description');
$Title = $jResp->stringOf('trigger_revision.snapshot.title');
$v_Url = $jResp->stringOf('trigger_revision.url');
$i = 0;
$count_i = $jResp->SizeOfArray('trigger_revision.snapshot.actions');
while ($i < $count_i) {
    $jResp->put_I($i);
    $field = $jResp->stringOf('trigger_revision.snapshot.actions[i].field');
    $value = $jResp->stringOf('trigger_revision.snapshot.actions[i].value');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('trigger_revision.snapshot.conditions.all');
while ($i < $count_i) {
    $jResp->put_I($i);
    $field = $jResp->stringOf('trigger_revision.snapshot.conditions.all[i].field');
    $operator = $jResp->stringOf('trigger_revision.snapshot.conditions.all[i].operator');
    $value = $jResp->stringOf('trigger_revision.snapshot.conditions.all[i].value');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('trigger_revision.snapshot.conditions.any');
while ($i < $count_i) {
    $jResp->put_I($i);
    $field = $jResp->stringOf('trigger_revision.snapshot.conditions.any[i].field');
    $operator = $jResp->stringOf('trigger_revision.snapshot.conditions.any[i].operator');
    $value = $jResp->stringOf('trigger_revision.snapshot.conditions.any[i].value');
    $i = $i + 1;
}


?>

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/:trigger_id/revisions/:trigger_revision_id

Postman Collection Item JSON

{
  "name": "Show Trigger Revision",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/triggers/:trigger_id/revisions/:trigger_revision_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "triggers",
        ":trigger_id",
        "revisions",
        ":trigger_revision_id"
      ],
      "variable": [
        {
          "key": "trigger_id",
          "value": "<integer>"
        },
        {
          "key": "trigger_revision_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Fetches a revision associated with a trigger. Trigger revision history is only available on Enterprise plans.\n\n#### Allowed For\n\n * Agents\n\n#### Sideloads\n\nThe following sideloads are supported:\n\n| Name  | Will sideload\n| ----- | -------------\n| users | The user that authored each revision\n"
  },
  "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/triggers/:trigger_id/revisions/:trigger_revision_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "triggers",
            ":trigger_id",
            "revisions",
            ":trigger_revision_id"
          ],
          "variable": [
            {
              "key": "trigger_id"
            },
            {
              "key": "trigger_revision_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"trigger_revision\": {\n    \"author_id\": \"<integer>\",\n    \"created_at\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"snapshot\": {\n      \"actions\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"active\": \"<boolean>\",\n      \"conditions\": {\n        \"all\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"any\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ]\n      },\n      \"description\": \"<string>\",\n      \"title\": \"<string>\"\n    },\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}