Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @v_type nvarchar(4000)
DECLARE @Created nvarchar(4000)
DECLARE @Description nvarchar(4000)
DECLARE @Display_name nvarchar(4000)
DECLARE @Display_type nvarchar(4000)
DECLARE @Group_name nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @Restricted nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @Created OUT, 'data[i].attributes.created'
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'data[i].attributes.description'
EXEC sp_OAMethod @jResp, 'StringOf', @Display_name OUT, 'data[i].attributes.display_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Display_type OUT, 'data[i].attributes.display_type'
EXEC sp_OAMethod @jResp, 'StringOf', @Group_name OUT, 'data[i].attributes.group_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data[i].attributes.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Restricted OUT, 'data[i].attributes.restricted'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].id'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
