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/users/:user_uuid/memberships', @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": [
-- {
-- "id": "<string>",
-- "type": "team_memberships",
-- "attributes": {
-- "role": "admin"
-- },
-- "relationships": {
-- "user": {
-- "data": {
-- "id": "<string>",
-- "type": "users"
-- }
-- }
-- }
-- },
-- {
-- "id": "<string>",
-- "type": "team_memberships",
-- "attributes": {
-- "role": "admin"
-- },
-- "relationships": {
-- "user": {
-- "data": {
-- "id": "<string>",
-- "type": "users"
-- }
-- }
-- }
-- }
-- ],
-- "links": {
-- "first": "<string>",
-- "last": "<string>",
-- "next": "<string>",
-- "prev": "<string>",
-- "self": "<string>"
-- },
-- "meta": {
-- "pagination": {
-- "first_offset": "<long>",
-- "last_offset": "<long>",
-- "limit": "<long>",
-- "next_offset": "<long>",
-- "offset": "<long>",
-- "prev_offset": "<long>",
-- "total": "<long>",
-- "type": "<string>"
-- }
-- }
-- }
-- 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 @Role nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @DataType nvarchar(4000)
DECLARE @First nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @First OUT, 'links.first'
DECLARE @Last nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last OUT, 'links.last'
DECLARE @v_Next nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Next OUT, 'links.next'
DECLARE @Prev nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Prev OUT, 'links.prev'
DECLARE @v_Self nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Self OUT, 'links.self'
DECLARE @First_offset nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @First_offset OUT, 'meta.pagination.first_offset'
DECLARE @Last_offset nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last_offset OUT, 'meta.pagination.last_offset'
DECLARE @Limit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Limit OUT, 'meta.pagination.limit'
DECLARE @Next_offset nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Next_offset OUT, 'meta.pagination.next_offset'
DECLARE @Offset nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Offset OUT, 'meta.pagination.offset'
DECLARE @Prev_offset nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Prev_offset OUT, 'meta.pagination.prev_offset'
DECLARE @Total nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Total OUT, 'meta.pagination.total'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'meta.pagination.type'
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', @id OUT, 'data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @Role OUT, 'data[i].attributes.role'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data[i].relationships.user.data.id'
EXEC sp_OAMethod @jResp, 'StringOf', @DataType OUT, 'data[i].relationships.user.data.type'
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/users/:user_uuid/memberships
Postman Collection Item JSON
{
"name": "Get user memberships",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid",
"value": "<string>"
}
]
},
"description": "Get a list of memberships for a user"
},
"response": [
{
"name": "Represents a user's association to a team",
"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/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"<string>\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"first\": \"<string>\",\n \"last\": \"<string>\",\n \"next\": \"<string>\",\n \"prev\": \"<string>\",\n \"self\": \"<string>\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": \"<long>\",\n \"last_offset\": \"<long>\",\n \"limit\": \"<long>\",\n \"next_offset\": \"<long>\",\n \"offset\": \"<long>\",\n \"prev_offset\": \"<long>\",\n \"total\": \"<long>\",\n \"type\": \"<string>\"\n }\n }\n}"
},
{
"name": "API error response.",
"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/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"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": "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/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"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}"
}
]
}
