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
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'search', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'tags', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'from', '<long>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'to', '<long>'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page[limit]', 1000
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'page[cursor]', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.app.ddog-gov.com/api/v2/processes', @queryParams
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 @queryParams
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 @queryParams
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": {
-- "cmdline": "<string>",
-- "host": "<string>",
-- "pid": "<long>",
-- "ppid": "<long>",
-- "start": "<string>",
-- "tags": [
-- "<string>",
-- "<string>"
-- ],
-- "timestamp": "<string>",
-- "user": "<string>"
-- },
-- "id": "<string>",
-- "type": "process"
-- },
-- {
-- "attributes": {
-- "cmdline": "<string>",
-- "host": "<string>",
-- "pid": "<long>",
-- "ppid": "<long>",
-- "start": "<string>",
-- "tags": [
-- "<string>",
-- "<string>"
-- ],
-- "timestamp": "<string>",
-- "user": "<string>"
-- },
-- "id": "<string>",
-- "type": "process"
-- }
-- ],
-- "meta": {
-- "page": {
-- "after": "<string>",
-- "size": "<integer>"
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @Cmdline nvarchar(4000)
DECLARE @Host nvarchar(4000)
DECLARE @Pid nvarchar(4000)
DECLARE @Ppid nvarchar(4000)
DECLARE @Start nvarchar(4000)
DECLARE @Timestamp nvarchar(4000)
DECLARE @User nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @After nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @After OUT, 'meta.page.after'
DECLARE @Size nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Size OUT, 'meta.page.size'
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', @Cmdline OUT, 'data[i].attributes.cmdline'
EXEC sp_OAMethod @jResp, 'StringOf', @Host OUT, 'data[i].attributes.host'
EXEC sp_OAMethod @jResp, 'StringOf', @Pid OUT, 'data[i].attributes.pid'
EXEC sp_OAMethod @jResp, 'StringOf', @Ppid OUT, 'data[i].attributes.ppid'
EXEC sp_OAMethod @jResp, 'StringOf', @Start OUT, 'data[i].attributes.start'
EXEC sp_OAMethod @jResp, 'StringOf', @Timestamp OUT, 'data[i].attributes.timestamp'
EXEC sp_OAMethod @jResp, 'StringOf', @User OUT, 'data[i].attributes.user'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data[i].type'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'data[i].attributes.tags'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'data[i].attributes.tags[j]'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "search=%3Cstring%3E"
-d "tags=%3Cstring%3E"
-d "from=%3Clong%3E"
-d "to=%3Clong%3E"
-d "page[limit]=1000"
-d "page[cursor]=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/processes
Postman Collection Item JSON
{
"name": "Get all processes",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
},
"description": "Get all processes for 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/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"cmdline\": \"<string>\",\n \"host\": \"<string>\",\n \"pid\": \"<long>\",\n \"ppid\": \"<long>\",\n \"start\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"process\"\n },\n {\n \"attributes\": {\n \"cmdline\": \"<string>\",\n \"host\": \"<string>\",\n \"pid\": \"<long>\",\n \"ppid\": \"<long>\",\n \"start\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"process\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"after\": \"<string>\",\n \"size\": \"<integer>\"\n }\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/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"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/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"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/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"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}"
}
]
}
