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/sensitive-data-scanner/config', @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": {
-- "attributes": {
-- "ametf": {},
-- "ead6": {},
-- "dolore03e": {}
-- },
-- "id": "<string>",
-- "relationships": {
-- "groups": {
-- "data": [
-- {
-- "id": "<string>",
-- "type": "sensitive_data_scanner_group"
-- },
-- {
-- "id": "<string>",
-- "type": "sensitive_data_scanner_group"
-- }
-- ]
-- }
-- },
-- "type": "sensitive_data_scanner_configuration"
-- },
-- "included": [
-- {
-- "attributes": {
-- "description": "<string>",
-- "excluded_namespaces": [
-- "<string>",
-- "<string>"
-- ],
-- "is_enabled": "<boolean>",
-- "name": "<string>",
-- "namespaces": [
-- "<string>",
-- "<string>"
-- ],
-- "pattern": "<string>",
-- "tags": [
-- "<string>",
-- "<string>"
-- ],
-- "text_replacement": {
-- "number_of_chars": "<long>",
-- "replacement_string": "<string>",
-- "type": "none"
-- }
-- },
-- "id": "<string>",
-- "relationships": {
-- "group": {
-- "data": {
-- "id": "<string>",
-- "type": "sensitive_data_scanner_group"
-- }
-- },
-- "standard_pattern": {
-- "data": {
-- "id": "<string>",
-- "type": "sensitive_data_scanner_standard_pattern"
-- }
-- }
-- },
-- "type": "sensitive_data_scanner_rule"
-- },
-- {
-- "attributes": {
-- "description": "<string>",
-- "excluded_namespaces": [
-- "<string>",
-- "<string>"
-- ],
-- "is_enabled": "<boolean>",
-- "name": "<string>",
-- "namespaces": [
-- "<string>",
-- "<string>"
-- ],
-- "pattern": "<string>",
-- "tags": [
-- "<string>",
-- "<string>"
-- ],
-- "text_replacement": {
-- "number_of_chars": "<long>",
-- "replacement_string": "<string>",
-- "type": "none"
-- }
-- },
-- "id": "<string>",
-- "relationships": {
-- "group": {
-- "data": {
-- "id": "<string>",
-- "type": "sensitive_data_scanner_group"
-- }
-- },
-- "standard_pattern": {
-- "data": {
-- "id": "<string>",
-- "type": "sensitive_data_scanner_standard_pattern"
-- }
-- }
-- },
-- "type": "sensitive_data_scanner_rule"
-- }
-- ],
-- "meta": {
-- "count_limit": "<long>",
-- "group_count_limit": "<long>",
-- "has_highlight_enabled": "<boolean>",
-- "has_multi_pass_enabled": "<boolean>",
-- "is_pci_compliant": "<boolean>",
-- "version": "<long>"
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @Description nvarchar(4000)
DECLARE @Is_enabled nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @Pattern nvarchar(4000)
DECLARE @Number_of_chars nvarchar(4000)
DECLARE @Replacement_string nvarchar(4000)
DECLARE @Text_replacementType nvarchar(4000)
DECLARE @DataId nvarchar(4000)
DECLARE @DataType nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.id'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data.type'
DECLARE @Count_limit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Count_limit OUT, 'meta.count_limit'
DECLARE @Group_count_limit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Group_count_limit OUT, 'meta.group_count_limit'
DECLARE @Has_highlight_enabled nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Has_highlight_enabled OUT, 'meta.has_highlight_enabled'
DECLARE @Has_multi_pass_enabled nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Has_multi_pass_enabled OUT, 'meta.has_multi_pass_enabled'
DECLARE @Is_pci_compliant nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Is_pci_compliant OUT, 'meta.is_pci_compliant'
DECLARE @Version nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Version OUT, 'meta.version'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.relationships.groups.data'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data.relationships.groups.data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data.relationships.groups.data[i].type'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'included'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'included[i].attributes.description'
EXEC sp_OAMethod @jResp, 'StringOf', @Is_enabled OUT, 'included[i].attributes.is_enabled'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'included[i].attributes.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Pattern OUT, 'included[i].attributes.pattern'
EXEC sp_OAMethod @jResp, 'StringOf', @Number_of_chars OUT, 'included[i].attributes.text_replacement.number_of_chars'
EXEC sp_OAMethod @jResp, 'StringOf', @Replacement_string OUT, 'included[i].attributes.text_replacement.replacement_string'
EXEC sp_OAMethod @jResp, 'StringOf', @Text_replacementType OUT, 'included[i].attributes.text_replacement.type'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'included[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @DataId OUT, 'included[i].relationships.group.data.id'
EXEC sp_OAMethod @jResp, 'StringOf', @DataType OUT, 'included[i].relationships.group.data.type'
EXEC sp_OAMethod @jResp, 'StringOf', @DataId OUT, 'included[i].relationships.standard_pattern.data.id'
EXEC sp_OAMethod @jResp, 'StringOf', @DataType OUT, 'included[i].relationships.standard_pattern.data.type'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'included[i].type'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'included[i].attributes.excluded_namespaces'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'included[i].attributes.excluded_namespaces[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'included[i].attributes.namespaces'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'included[i].attributes.namespaces[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'included[i].attributes.tags'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'included[i].attributes.tags[j]'
SELECT @j = @j + 1
END
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/sensitive-data-scanner/config
Postman Collection Item JSON
{
"name": "List Scanning Groups",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
},
"description": "List all the Scanning groups in your organization."
},
"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/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"ametf\": {},\n \"ead6\": {},\n \"dolore03e\": {}\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ],\n \"meta\": {\n \"count_limit\": \"<long>\",\n \"group_count_limit\": \"<long>\",\n \"has_highlight_enabled\": \"<boolean>\",\n \"has_multi_pass_enabled\": \"<boolean>\",\n \"is_pci_compliant\": \"<boolean>\",\n \"version\": \"<long>\"\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/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"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": "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/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"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/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"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}"
}
]
}
