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
DECLARE @iTmp0 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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "name": "New private location",
-- "description": "Description of private location",
-- "tags": [
-- "team:front"
-- ],
-- "id": "Duis incididunt ea Lorem",
-- "metadata": {
-- "restricted_roles": [
-- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
-- ]
-- },
-- "secrets": {
-- "authentication": {
-- "id": "quis aliqua dolor reprehenderit",
-- "key": "laboris pariatur"
-- },
-- "config_decryption": {
-- "key": "voluptate mollit commodo deserunt"
-- }
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', 'New private location'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'description', 'Description of private location'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'tags[0]', 'team:front'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'id', 'Duis incididunt ea Lorem'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'metadata.restricted_roles[0]', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'secrets.authentication.id', 'quis aliqua dolor reprehenderit'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'secrets.authentication.key', 'laboris pariatur'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'secrets.config_decryption.key', 'voluptate mollit commodo deserunt'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.app.ddog-gov.com/api/v1/synthetics/private-locations', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "config": {},
-- "private_location": {
-- "name": "New private location",
-- "description": "Description of private location",
-- "tags": [
-- "team:front"
-- ],
-- "id": "amet",
-- "metadata": {
-- "restricted_roles": [
-- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
-- ]
-- },
-- "secrets": {
-- "authentication": {
-- "id": "voluptate enim labore adipisicing",
-- "key": "cillum"
-- },
-- "config_decryption": {
-- "key": "anim nostrud et"
-- }
-- }
-- },
-- "result_encryption": {
-- "id": "e",
-- "key": "laboris"
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @strVal nvarchar(4000)
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'private_location.name'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'private_location.description'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'private_location.id'
DECLARE @AuthenticationId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AuthenticationId OUT, 'private_location.secrets.authentication.id'
DECLARE @Key nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Key OUT, 'private_location.secrets.authentication.key'
DECLARE @Config_decryptionKey nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Config_decryptionKey OUT, 'private_location.secrets.config_decryption.key'
DECLARE @result_encryptionId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @result_encryptionId OUT, 'result_encryption.id'
DECLARE @result_encryptionKey nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @result_encryptionKey OUT, 'result_encryption.key'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'private_location.tags'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'private_location.tags[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'private_location.metadata.restricted_roles'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'private_location.metadata.restricted_roles[i]'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"name": "New private location",
"description": "Description of private location",
"tags": [
"team:front"
],
"id": "Duis incididunt ea Lorem",
"metadata": {
"restricted_roles": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
]
},
"secrets": {
"authentication": {
"id": "quis aliqua dolor reprehenderit",
"key": "laboris pariatur"
},
"config_decryption": {
"key": "voluptate mollit commodo deserunt"
}
}
}'
https://api.app.ddog-gov.com/api/v1/synthetics/private-locations
Postman Collection Item JSON
{
"name": "Create a private location",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
},
"description": "Create a new Synthetic private location."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"config\": {},\n \"private_location\": {\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"amet\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"voluptate enim labore adipisicing\",\n \"key\": \"cillum\"\n },\n \"config_decryption\": {\n \"key\": \"anim nostrud et\"\n }\n }\n },\n \"result_encryption\": {\n \"id\": \"e\",\n \"key\": \"laboris\"\n }\n}"
},
{
"name": "Quota reached for private locations",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Private locations are not activated for the user",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
