Chilkat Online Tools

phpAx / Support API / Show Workspace

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';

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

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/workspaces/:workspace_id',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

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

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

// {
//   "workspace": {
//     "activated": "<boolean>",
//     "apps": [
//       {
//         "ad_be": true,
//         "ead07": 69455617,
//         "adipisicinga": true
//       },
//       {
//         "fugiat_e": false,
//         "dolorf7": -57129708.70016649
//       }
//     ],
//     "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>"
//         }
//       ]
//     },
//     "created_at": "<dateTime>",
//     "description": "<string>",
//     "id": "<integer>",
//     "macro_ids": [
//       "<integer>",
//       "<integer>"
//     ],
//     "macros": [
//       "<integer>",
//       "<integer>"
//     ],
//     "position": "<integer>",
//     "prefer_workspace_app_order": "<boolean>",
//     "selected_macros": [
//       {
//         "actions": [
//           {
//             "field": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "value": "<string>"
//           }
//         ],
//         "title": "<string>",
//         "active": "<boolean>",
//         "created_at": "<dateTime>",
//         "default": "<boolean>",
//         "description": "<string>",
//         "id": "<integer>",
//         "position": "<integer>",
//         "restriction": {
//           "in_f25": true,
//           "nisid81": "reprehenderit anim nostrud id",
//           "minim_886": false
//         },
//         "updated_at": "<dateTime>",
//         "url": "<string>",
//         "app_installation": "<string>",
//         "categories": "<string>",
//         "permissions": "<string>",
//         "usage_1h": "<integer>",
//         "usage_7d": "<integer>",
//         "usage_24h": "<integer>",
//         "usage_30d": "<integer>"
//       },
//       {
//         "actions": [
//           {
//             "field": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "value": "<string>"
//           }
//         ],
//         "title": "<string>",
//         "active": "<boolean>",
//         "created_at": "<dateTime>",
//         "default": "<boolean>",
//         "description": "<string>",
//         "id": "<integer>",
//         "position": "<integer>",
//         "restriction": {
//           "culpa__d7": false,
//           "ad7": true,
//           "esse0": -82046233.9137964,
//           "veniam_f": -91185504
//         },
//         "updated_at": "<dateTime>",
//         "url": "<string>",
//         "app_installation": "<string>",
//         "categories": "<string>",
//         "permissions": "<string>",
//         "usage_1h": "<integer>",
//         "usage_7d": "<integer>",
//         "usage_24h": "<integer>",
//         "usage_30d": "<integer>"
//       }
//     ],
//     "ticket_form_id": "<integer>",
//     "title": "<string>",
//     "updated_at": "<dateTime>",
//     "url": "<string>"
//   }
// }

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

$Activated = $jResp->stringOf('workspace.activated');
$Created_at = $jResp->stringOf('workspace.created_at');
$Description = $jResp->stringOf('workspace.description');
$Id = $jResp->stringOf('workspace.id');
$Position = $jResp->stringOf('workspace.position');
$Prefer_workspace_app_order = $jResp->stringOf('workspace.prefer_workspace_app_order');
$Ticket_form_id = $jResp->stringOf('workspace.ticket_form_id');
$Title = $jResp->stringOf('workspace.title');
$Updated_at = $jResp->stringOf('workspace.updated_at');
$v_Url = $jResp->stringOf('workspace.url');
$i = 0;
$count_i = $jResp->SizeOfArray('workspace.apps');
while ($i < $count_i) {
    $jResp->I = $i;
    $ad_be = $jResp->BoolOf('workspace.apps[i].ad_be');
    $ead07 = $jResp->IntOf('workspace.apps[i].ead07');
    $adipisicinga = $jResp->BoolOf('workspace.apps[i].adipisicinga');
    $fugiat_e = $jResp->BoolOf('workspace.apps[i].fugiat_e');
    $dolorf7 = $jResp->stringOf('workspace.apps[i].dolorf7');
    $i = $i + 1;
}

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

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

$i = 0;
$count_i = $jResp->SizeOfArray('workspace.macro_ids');
while ($i < $count_i) {
    $jResp->I = $i;
    $strVal = $jResp->stringOf('workspace.macro_ids[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('workspace.macros');
while ($i < $count_i) {
    $jResp->I = $i;
    $strVal = $jResp->stringOf('workspace.macros[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('workspace.selected_macros');
while ($i < $count_i) {
    $jResp->I = $i;
    $title = $jResp->stringOf('workspace.selected_macros[i].title');
    $active = $jResp->stringOf('workspace.selected_macros[i].active');
    $created_at = $jResp->stringOf('workspace.selected_macros[i].created_at');
    $default = $jResp->stringOf('workspace.selected_macros[i].default');
    $description = $jResp->stringOf('workspace.selected_macros[i].description');
    $id = $jResp->stringOf('workspace.selected_macros[i].id');
    $position = $jResp->stringOf('workspace.selected_macros[i].position');
    $In_f25 = $jResp->BoolOf('workspace.selected_macros[i].restriction.in_f25');
    $Nisid81 = $jResp->stringOf('workspace.selected_macros[i].restriction.nisid81');
    $Minim_886 = $jResp->BoolOf('workspace.selected_macros[i].restriction.minim_886');
    $updated_at = $jResp->stringOf('workspace.selected_macros[i].updated_at');
    $url = $jResp->stringOf('workspace.selected_macros[i].url');
    $app_installation = $jResp->stringOf('workspace.selected_macros[i].app_installation');
    $categories = $jResp->stringOf('workspace.selected_macros[i].categories');
    $permissions = $jResp->stringOf('workspace.selected_macros[i].permissions');
    $usage_1h = $jResp->stringOf('workspace.selected_macros[i].usage_1h');
    $usage_7d = $jResp->stringOf('workspace.selected_macros[i].usage_7d');
    $usage_24h = $jResp->stringOf('workspace.selected_macros[i].usage_24h');
    $usage_30d = $jResp->stringOf('workspace.selected_macros[i].usage_30d');
    $Culpa__d7 = $jResp->BoolOf('workspace.selected_macros[i].restriction.culpa__d7');
    $Ad7 = $jResp->BoolOf('workspace.selected_macros[i].restriction.ad7');
    $Esse0 = $jResp->stringOf('workspace.selected_macros[i].restriction.esse0');
    $Veniam_f = $jResp->IntOf('workspace.selected_macros[i].restriction.veniam_f');
    $j = 0;
    $count_j = $jResp->SizeOfArray('workspace.selected_macros[i].actions');
    while ($j < $count_j) {
        $jResp->J = $j;
        $field = $jResp->stringOf('workspace.selected_macros[i].actions[j].field');
        $value = $jResp->stringOf('workspace.selected_macros[i].actions[j].value');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/workspaces/:workspace_id

Postman Collection Item JSON

{
  "name": "Show Workspace",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/workspaces/:workspace_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "workspaces",
        ":workspace_id"
      ],
      "variable": [
        {
          "key": "workspace_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n* Admins\n"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/workspaces/:workspace_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "workspaces",
            ":workspace_id"
          ],
          "variable": [
            {
              "key": "workspace_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"workspace\": {\n    \"activated\": \"<boolean>\",\n    \"apps\": [\n      {\n        \"ad_be\": true,\n        \"ead07\": 69455617,\n        \"adipisicinga\": true\n      },\n      {\n        \"fugiat_e\": false,\n        \"dolorf7\": -57129708.70016649\n      }\n    ],\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    \"created_at\": \"<dateTime>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"macro_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"macros\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"position\": \"<integer>\",\n    \"prefer_workspace_app_order\": \"<boolean>\",\n    \"selected_macros\": [\n      {\n        \"actions\": [\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"title\": \"<string>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"restriction\": {\n          \"in_f25\": true,\n          \"nisid81\": \"reprehenderit anim nostrud id\",\n          \"minim_886\": false\n        },\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\",\n        \"app_installation\": \"<string>\",\n        \"categories\": \"<string>\",\n        \"permissions\": \"<string>\",\n        \"usage_1h\": \"<integer>\",\n        \"usage_7d\": \"<integer>\",\n        \"usage_24h\": \"<integer>\",\n        \"usage_30d\": \"<integer>\"\n      },\n      {\n        \"actions\": [\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"title\": \"<string>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"restriction\": {\n          \"culpa__d7\": false,\n          \"ad7\": true,\n          \"esse0\": -82046233.9137964,\n          \"veniam_f\": -91185504\n        },\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\",\n        \"app_installation\": \"<string>\",\n        \"categories\": \"<string>\",\n        \"permissions\": \"<string>\",\n        \"usage_1h\": \"<integer>\",\n        \"usage_7d\": \"<integer>\",\n        \"usage_24h\": \"<integer>\",\n        \"usage_30d\": \"<integer>\"\n      }\n    ],\n    \"ticket_form_id\": \"<integer>\",\n    \"title\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}