Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/logs/config/archives/:archive_id/readers",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sV_type
Local $sCreated_at
Local $sModified_at
Local $sName
Local $sUser_count
Local $sId
Local $iJ
Local $iCount_j
Local $sTotal_count = $oJResp.StringOf("meta.page.total_count")
Local $sTotal_filtered_count = $oJResp.StringOf("meta.page.total_filtered_count")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sV_type = $oJResp.StringOf("data[i].type")
$sCreated_at = $oJResp.StringOf("data[i].attributes.created_at")
$sModified_at = $oJResp.StringOf("data[i].attributes.modified_at")
$sName = $oJResp.StringOf("data[i].attributes.name")
$sUser_count = $oJResp.StringOf("data[i].attributes.user_count")
$sId = $oJResp.StringOf("data[i].id")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].relationships.permissions.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("data[i].relationships.permissions.data[j].id")
$sV_type = $oJResp.StringOf("data[i].relationships.permissions.data[j].type")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
