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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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": {
-- "id": "<string>",
-- "attributes": {
-- "name": "<string>",
-- "filter": {
-- "query": "<string>"
-- },
-- "enabled": "<boolean>",
-- "filter_type": "spans-sampling-processor",
-- "rate": "<double>"
-- },
-- "type": "apm_retention_filter"
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.id', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.attributes.name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.attributes.filter.query', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.attributes.enabled', '<boolean>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.attributes.filter_type', 'spans-sampling-processor'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.attributes.rate', '<double>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.type', 'apm_retention_filter'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_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
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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": {
-- "id": "<string>",
-- "type": "apm_retention_filter",
-- "attributes": {
-- "created_at": "<long>",
-- "created_by": "<string>",
-- "editable": "<boolean>",
-- "enabled": "<boolean>",
-- "execution_order": "<long>",
-- "filter": {
-- "query": "<string>"
-- },
-- "filter_type": "spans-sampling-processor",
-- "modified_at": "<long>",
-- "modified_by": "<string>",
-- "name": "<string>",
-- "rate": "<double>"
-- }
-- }
-- }
-- 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)
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 @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'data.attributes.created_at'
DECLARE @Created_by nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_by OUT, 'data.attributes.created_by'
DECLARE @Editable nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Editable OUT, 'data.attributes.editable'
DECLARE @Enabled nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Enabled OUT, 'data.attributes.enabled'
DECLARE @Execution_order nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Execution_order OUT, 'data.attributes.execution_order'
DECLARE @Query nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Query OUT, 'data.attributes.filter.query'
DECLARE @Filter_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Filter_type OUT, 'data.attributes.filter_type'
DECLARE @Modified_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Modified_at OUT, 'data.attributes.modified_at'
DECLARE @Modified_by nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Modified_by OUT, 'data.attributes.modified_by'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data.attributes.name'
DECLARE @Rate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Rate OUT, 'data.attributes.rate'
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 PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"attributes": {
"name": "<string>",
"filter": {
"query": "<string>"
},
"enabled": "<boolean>",
"filter_type": "spans-sampling-processor",
"rate": "<double>"
},
"type": "apm_retention_filter"
}
}'
https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_id
Postman Collection Item JSON
{
"name": "Update a retention filter",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id",
"value": "<string>"
}
]
},
"description": "Update a retention filter from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"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 \"id\": \"<string>\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": \"<long>\",\n \"created_by\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"enabled\": \"<boolean>\",\n \"execution_order\": \"<long>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": \"<long>\",\n \"modified_by\": \"<string>\",\n \"name\": \"<string>\",\n \"rate\": \"<double>\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"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 \"id\": \"<string>\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_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": "Not Authorized",
"originalRequest": {
"method": "PUT",
"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 \"id\": \"<string>\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_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": "PUT",
"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 \"id\": \"<string>\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_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": "PUT",
"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 \"id\": \"<string>\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_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}"
}
]
}
