Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.SetRequestHeader "Accept","application/json"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions",sbResponseBody)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(http.LastHeader)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "type": "permissions",
// "attributes": {
// "created": "<dateTime>",
// "description": "<string>",
// "display_name": "<string>",
// "display_type": "<string>",
// "group_name": "<string>",
// "name": "<string>",
// "restricted": "<boolean>"
// },
// "id": "<string>"
// },
// {
// "type": "permissions",
// "attributes": {
// "created": "<dateTime>",
// "description": "<string>",
// "display_name": "<string>",
// "display_type": "<string>",
// "group_name": "<string>",
// "name": "<string>",
// "restricted": "<boolean>"
// },
// "id": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim v_type As String
Dim Created As String
Dim Description As String
Dim Display_name As String
Dim Display_type As String
Dim Group_name As String
Dim Name As String
Dim Restricted As String
Dim id As String
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("data")
While i < count_i
jResp.I = i
v_type = jResp.StringOf("data[i].type")
Created = jResp.StringOf("data[i].attributes.created")
Description = jResp.StringOf("data[i].attributes.description")
Display_name = jResp.StringOf("data[i].attributes.display_name")
Display_type = jResp.StringOf("data[i].attributes.display_type")
Group_name = jResp.StringOf("data[i].attributes.group_name")
Name = jResp.StringOf("data[i].attributes.name")
Restricted = jResp.StringOf("data[i].attributes.restricted")
id = jResp.StringOf("data[i].id")
i = i + 1
Wend
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions
Postman Collection Item JSON
{
"name": "List permissions for a role",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id",
"value": "<string>"
}
]
},
"description": "Returns a list of all permissions for a single role."
},
"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/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"display_type\": \"<string>\",\n \"group_name\": \"<string>\",\n \"name\": \"<string>\",\n \"restricted\": \"<boolean>\"\n },\n \"id\": \"<string>\"\n },\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"display_type\": \"<string>\",\n \"group_name\": \"<string>\",\n \"name\": \"<string>\",\n \"restricted\": \"<boolean>\"\n },\n \"id\": \"<string>\"\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/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_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/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_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/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_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}"
}
]
}
