Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateInt("page[size]",10)
$queryParams.UpdateInt("page[number]",0)
$queryParams.UpdateString("sort","email")
$queryParams.UpdateString("filter[keyword]","<string>")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/team/:team_id/memberships",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$First = $jResp.StringOf("links.first")
$Last = $jResp.StringOf("links.last")
$v_Next = $jResp.StringOf("links.next")
$Prev = $jResp.StringOf("links.prev")
$v_Self = $jResp.StringOf("links.self")
$First_offset = $jResp.StringOf("meta.pagination.first_offset")
$Last_offset = $jResp.StringOf("meta.pagination.last_offset")
$Limit = $jResp.StringOf("meta.pagination.limit")
$Next_offset = $jResp.StringOf("meta.pagination.next_offset")
$Offset = $jResp.StringOf("meta.pagination.offset")
$Prev_offset = $jResp.StringOf("meta.pagination.prev_offset")
$Total = $jResp.StringOf("meta.pagination.total")
$v_Type = $jResp.StringOf("meta.pagination.type")
$i = 0
$count_i = $jResp.SizeOfArray("data")
while ($i -lt $count_i) {
$jResp.I = $i
$id = $jResp.StringOf("data[i].id")
$v_type = $jResp.StringOf("data[i].type")
$Role = $jResp.StringOf("data[i].attributes.role")
$Id = $jResp.StringOf("data[i].relationships.user.data.id")
$DataType = $jResp.StringOf("data[i].relationships.user.data.type")
$i = $i + 1
}
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-d "sort=email"
-d "filter[keyword]=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/team/:team_id/memberships
Postman Collection Item JSON
{
"name": "Get team memberships",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "email",
"description": "Specifies the order of returned team memberships"
},
{
"key": "filter[keyword]",
"value": "<string>",
"description": "Search query, can be user email or name"
}
],
"variable": [
{
"key": "team_id",
"value": "<string>"
}
]
},
"description": "Get a paginated list of members for a team"
},
"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/team/:team_id/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "email",
"description": "Specifies the order of returned team memberships"
},
{
"key": "filter[keyword]",
"value": "<string>",
"description": "Search query, can be user email or name"
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"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/team/:team_id/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "email",
"description": "Specifies the order of returned team memberships"
},
{
"key": "filter[keyword]",
"value": "<string>",
"description": "Search query, can be user email or name"
}
],
"variable": [
{
"key": "team_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": "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/team/:team_id/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "email",
"description": "Specifies the order of returned team memberships"
},
{
"key": "filter[keyword]",
"value": "<string>",
"description": "Search query, can be user email or name"
}
],
"variable": [
{
"key": "team_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}"
}
]
}
