Chilkat Online Tools

phpExt / Datadog API Collection / List roles

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->UpdateInt('page[size]',10);
$queryParams->UpdateInt('page[number]',0);
$queryParams->UpdateString('sort','name');
$queryParams->UpdateString('filter','<string>');

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

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api.app.ddog-gov.com/api/v2/roles',$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)

// {
//   "data": [
//     {
//       "type": "roles",
//       "attributes": {
//         "created_at": "<dateTime>",
//         "modified_at": "<dateTime>",
//         "name": "<string>",
//         "user_count": "<long>"
//       },
//       "id": "<string>",
//       "relationships": {
//         "permissions": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "permissions"
//             },
//             {
//               "id": "<string>",
//               "type": "permissions"
//             }
//           ]
//         }
//       }
//     },
//     {
//       "type": "roles",
//       "attributes": {
//         "created_at": "<dateTime>",
//         "modified_at": "<dateTime>",
//         "name": "<string>",
//         "user_count": "<long>"
//       },
//       "id": "<string>",
//       "relationships": {
//         "permissions": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "permissions"
//             },
//             {
//               "id": "<string>",
//               "type": "permissions"
//             }
//           ]
//         }
//       }
//     }
//   ],
//   "meta": {
//     "page": {
//       "total_count": "<long>",
//       "total_filtered_count": "<long>"
//     }
//   }
// }

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

$Total_count = $jResp->stringOf('meta.page.total_count');
$Total_filtered_count = $jResp->stringOf('meta.page.total_filtered_count');
$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
    $jResp->put_I($i);
    $v_type = $jResp->stringOf('data[i].type');
    $Created_at = $jResp->stringOf('data[i].attributes.created_at');
    $Modified_at = $jResp->stringOf('data[i].attributes.modified_at');
    $Name = $jResp->stringOf('data[i].attributes.name');
    $User_count = $jResp->stringOf('data[i].attributes.user_count');
    $id = $jResp->stringOf('data[i].id');
    $j = 0;
    $count_j = $jResp->SizeOfArray('data[i].relationships.permissions.data');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $id = $jResp->stringOf('data[i].relationships.permissions.data[j].id');
        $v_type = $jResp->stringOf('data[i].relationships.permissions.data[j].type');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

Curl Command

curl -G -d "page[size]=10"
	-d "page[number]=0"
	-d "sort=name"
	-d "filter=%3Cstring%3E"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/roles

Postman Collection Item JSON

{
  "name": "List roles",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "roles"
      ],
      "query": [
        {
          "key": "page[size]",
          "value": "10",
          "description": "Size for a given page. The maximum allowed value is 100."
        },
        {
          "key": "page[number]",
          "value": "0",
          "description": "Specific page number to return."
        },
        {
          "key": "sort",
          "value": "name",
          "description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
        },
        {
          "key": "filter",
          "value": "<string>",
          "description": "Filter all roles by the given string."
        }
      ]
    },
    "description": "Returns all roles, including their names and their unique identifiers."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles"
          ],
          "query": [
            {
              "key": "page[size]",
              "value": "10",
              "description": "Size for a given page. The maximum allowed value is 100."
            },
            {
              "key": "page[number]",
              "value": "0",
              "description": "Specific page number to return."
            },
            {
              "key": "sort",
              "value": "name",
              "description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
            },
            {
              "key": "filter",
              "value": "<string>",
              "description": "Filter all roles by the given string."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"type\": \"roles\",\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"user_count\": \"<long>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"permissions\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"permissions\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"permissions\"\n            }\n          ]\n        }\n      }\n    },\n    {\n      \"type\": \"roles\",\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"user_count\": \"<long>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"permissions\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"permissions\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"permissions\"\n            }\n          ]\n        }\n      }\n    }\n  ],\n  \"meta\": {\n    \"page\": {\n      \"total_count\": \"<long>\",\n      \"total_filtered_count\": \"<long>\"\n    }\n  }\n}"
    },
    {
      "name": "Authentication error",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles"
          ],
          "query": [
            {
              "key": "page[size]",
              "value": "10",
              "description": "Size for a given page. The maximum allowed value is 100."
            },
            {
              "key": "page[number]",
              "value": "0",
              "description": "Specific page number to return."
            },
            {
              "key": "sort",
              "value": "name",
              "description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
            },
            {
              "key": "filter",
              "value": "<string>",
              "description": "Filter all roles by the given string."
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles"
          ],
          "query": [
            {
              "key": "page[size]",
              "value": "10",
              "description": "Size for a given page. The maximum allowed value is 100."
            },
            {
              "key": "page[number]",
              "value": "0",
              "description": "Specific page number to return."
            },
            {
              "key": "sort",
              "value": "name",
              "description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
            },
            {
              "key": "filter",
              "value": "<string>",
              "description": "Filter all roles by the given string."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}