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.
-- {
-- "data": {
-- "attributes": {
-- "name": "<string>"
-- },
-- "id": "<string>",
-- "type": "api_keys"
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.attributes.name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.id', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.type', 'api_keys'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PATCH', 'https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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
EXEC @hr = sp_OADestroy @sbRequestBody
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 @sbRequestBody
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)
-- {
-- "data": {
-- "attributes": {
-- "created_at": "<string>",
-- "key": "<string>",
-- "last4": "<string>",
-- "modified_at": "<string>",
-- "name": "<string>"
-- },
-- "id": "<string>",
-- "relationships": {
-- "created_by": {
-- "data": {
-- "id": "<string>",
-- "type": "users"
-- }
-- },
-- "modified_by": {
-- "data": {
-- "id": "<string>",
-- "type": "users"
-- }
-- }
-- },
-- "type": "api_keys"
-- },
-- "included": [
-- {
-- "attributes": {
-- "created_at": "<dateTime>",
-- "disabled": "<boolean>",
-- "email": "<string>",
-- "handle": "<string>",
-- "icon": "<string>",
-- "modified_at": "<dateTime>",
-- "name": "<string>",
-- "service_account": "<boolean>",
-- "status": "<string>",
-- "title": "<string>",
-- "verified": "<boolean>"
-- },
-- "id": "<string>",
-- "relationships": {
-- "org": {
-- "data": {
-- "id": "<string>",
-- "type": "orgs"
-- }
-- },
-- "other_orgs": {
-- "data": [
-- {
-- "id": "<string>",
-- "type": "orgs"
-- },
-- {
-- "id": "<string>",
-- "type": "orgs"
-- }
-- ]
-- },
-- "other_users": {
-- "data": [
-- {
-- "id": "<string>",
-- "type": "users"
-- },
-- {
-- "id": "<string>",
-- "type": "users"
-- }
-- ]
-- },
-- "roles": {
-- "data": [
-- {
-- "id": "<string>",
-- "type": "roles"
-- },
-- {
-- "id": "<string>",
-- "type": "roles"
-- }
-- ]
-- }
-- },
-- "type": "users"
-- },
-- {
-- "attributes": {
-- "created_at": "<dateTime>",
-- "disabled": "<boolean>",
-- "email": "<string>",
-- "handle": "<string>",
-- "icon": "<string>",
-- "modified_at": "<dateTime>",
-- "name": "<string>",
-- "service_account": "<boolean>",
-- "status": "<string>",
-- "title": "<string>",
-- "verified": "<boolean>"
-- },
-- "id": "<string>",
-- "relationships": {
-- "org": {
-- "data": {
-- "id": "<string>",
-- "type": "orgs"
-- }
-- },
-- "other_orgs": {
-- "data": [
-- {
-- "id": "<string>",
-- "type": "orgs"
-- },
-- {
-- "id": "<string>",
-- "type": "orgs"
-- }
-- ]
-- },
-- "other_users": {
-- "data": [
-- {
-- "id": "<string>",
-- "type": "users"
-- },
-- {
-- "id": "<string>",
-- "type": "users"
-- }
-- ]
-- },
-- "roles": {
-- "data": [
-- {
-- "id": "<string>",
-- "type": "roles"
-- },
-- {
-- "id": "<string>",
-- "type": "roles"
-- }
-- ]
-- }
-- },
-- "type": "users"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @attributesCreated_at nvarchar(4000)
DECLARE @Disabled nvarchar(4000)
DECLARE @v_Email nvarchar(4000)
DECLARE @Handle nvarchar(4000)
DECLARE @Icon nvarchar(4000)
DECLARE @attributesModified_at nvarchar(4000)
DECLARE @attributesName nvarchar(4000)
DECLARE @Service_account nvarchar(4000)
DECLARE @Status nvarchar(4000)
DECLARE @Title nvarchar(4000)
DECLARE @Verified nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'data.attributes.created_at'
DECLARE @Key nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Key OUT, 'data.attributes.key'
DECLARE @Last4 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last4 OUT, 'data.attributes.last4'
DECLARE @Modified_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Modified_at OUT, 'data.attributes.modified_at'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data.attributes.name'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.id'
DECLARE @DataId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DataId OUT, 'data.relationships.created_by.data.id'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data.relationships.created_by.data.type'
EXEC sp_OAMethod @jResp, 'StringOf', @DataId OUT, 'data.relationships.modified_by.data.id'
DECLARE @DataType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DataType OUT, 'data.relationships.modified_by.data.type'
DECLARE @dataType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @dataType OUT, 'data.type'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
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', @attributesCreated_at OUT, 'included[i].attributes.created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @Disabled OUT, 'included[i].attributes.disabled'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'included[i].attributes.email'
EXEC sp_OAMethod @jResp, 'StringOf', @Handle OUT, 'included[i].attributes.handle'
EXEC sp_OAMethod @jResp, 'StringOf', @Icon OUT, 'included[i].attributes.icon'
EXEC sp_OAMethod @jResp, 'StringOf', @attributesModified_at OUT, 'included[i].attributes.modified_at'
EXEC sp_OAMethod @jResp, 'StringOf', @attributesName OUT, 'included[i].attributes.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Service_account OUT, 'included[i].attributes.service_account'
EXEC sp_OAMethod @jResp, 'StringOf', @Status OUT, 'included[i].attributes.status'
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'included[i].attributes.title'
EXEC sp_OAMethod @jResp, 'StringOf', @Verified OUT, 'included[i].attributes.verified'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'included[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @DataId OUT, 'included[i].relationships.org.data.id'
EXEC sp_OAMethod @jResp, 'StringOf', @DataType OUT, 'included[i].relationships.org.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].relationships.other_orgs.data'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'included[i].relationships.other_orgs.data[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'included[i].relationships.other_orgs.data[j].type'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'included[i].relationships.other_users.data'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'included[i].relationships.other_users.data[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'included[i].relationships.other_users.data[j].type'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'included[i].relationships.roles.data'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'included[i].relationships.roles.data[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'included[i].relationships.roles.data[j].type'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"name": "<string>"
},
"id": "<string>",
"type": "api_keys"
}
}'
https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id
Postman Collection Item JSON
{
"name": "Edit an API key",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id",
"value": "<string>"
}
]
},
"description": "Update an API key."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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 \"data\": {\n \"attributes\": {\n \"name\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"<string>\",\n \"key\": \"<string>\",\n \"last4\": \"<string>\",\n \"modified_at\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"api_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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 \"data\": {\n \"attributes\": {\n \"name\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_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": "PATCH",
"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 \"data\": {\n \"attributes\": {\n \"name\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_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": "PATCH",
"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 \"data\": {\n \"attributes\": {\n \"name\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_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": "PATCH",
"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 \"data\": {\n \"attributes\": {\n \"name\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_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}"
}
]
}
