Chilkat Online Tools

delphiDll / Datadog API Collection / List read roles for an archive

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
v_type: PWideChar;
Created_at: PWideChar;
Modified_at: PWideChar;
Name: PWideChar;
User_count: PWideChar;
id: PWideChar;
j: Integer;
count_j: Integer;
Total_count: PWideChar;
Total_filtered_count: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.app.ddog-gov.com/api/v2/logs/config/archives/:archive_id/readers',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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 := CkJsonObject__stringOf(jResp,'meta.page.total_count');
Total_filtered_count := CkJsonObject__stringOf(jResp,'meta.page.total_filtered_count');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    v_type := CkJsonObject__stringOf(jResp,'data[i].type');
    Created_at := CkJsonObject__stringOf(jResp,'data[i].attributes.created_at');
    Modified_at := CkJsonObject__stringOf(jResp,'data[i].attributes.modified_at');
    Name := CkJsonObject__stringOf(jResp,'data[i].attributes.name');
    User_count := CkJsonObject__stringOf(jResp,'data[i].attributes.user_count');
    id := CkJsonObject__stringOf(jResp,'data[i].id');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'data[i].relationships.permissions.data');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        id := CkJsonObject__stringOf(jResp,'data[i].relationships.permissions.data[j].id');
        v_type := CkJsonObject__stringOf(jResp,'data[i].relationships.permissions.data[j].type');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/logs/config/archives/:archive_id/readers

Postman Collection Item JSON

{
  "name": "List read roles for an archive",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "config",
        "archives",
        ":archive_id",
        "readers"
      ],
      "variable": [
        {
          "key": "archive_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Returns all read roles a given archive is restricted to."
  },
  "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/logs/config/archives/:archive_id/readers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id",
            "readers"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "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": "Bad Request",
      "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/logs/config/archives/:archive_id/readers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id",
            "readers"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "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/logs/config/archives/:archive_id/readers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id",
            "readers"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "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": "Not found",
      "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/logs/config/archives/:archive_id/readers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id",
            "readers"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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/logs/config/archives/:archive_id/readers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id",
            "readers"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}