Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateInt("page[number]",0)
$oQueryParams.UpdateInt("page[size]",10)
$oQueryParams.UpdateString("sort","user_count")
$oQueryParams.UpdateString("include","user_team_permissions")
$oQueryParams.UpdateString("include","team_links")
$oQueryParams.UpdateString("filter[keyword]","<string>")
$oQueryParams.UpdateString("filter[me]","<boolean>")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/team",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": [
; {
; "attributes": {
; "handle": "<string>",
; "name": "<string>",
; "avatar": "<string>",
; "banner": "<long>",
; "created_at": "<dateTime>",
; "description": "<string>",
; "hidden_modules": [
; "<string>",
; "<string>"
; ],
; "link_count": "<integer>",
; "modified_at": "<dateTime>",
; "summary": "<string>",
; "user_count": "<integer>",
; "visible_modules": [
; "<string>",
; "<string>"
; ]
; },
; "id": "<string>",
; "type": "team",
; "relationships": {
; "team_links": {
; "data": [
; {
; "id": "<string>",
; "type": "team_links"
; },
; {
; "id": "<string>",
; "type": "team_links"
; }
; ],
; "links": {
; "related": "<string>"
; }
; },
; "user_team_permissions": {
; "data": {
; "id": "<string>",
; "type": "user_team_permissions"
; },
; "links": {
; "related": "<string>"
; }
; }
; }
; },
; {
; "attributes": {
; "handle": "<string>",
; "name": "<string>",
; "avatar": "<string>",
; "banner": "<long>",
; "created_at": "<dateTime>",
; "description": "<string>",
; "hidden_modules": [
; "<string>",
; "<string>"
; ],
; "link_count": "<integer>",
; "modified_at": "<dateTime>",
; "summary": "<string>",
; "user_count": "<integer>",
; "visible_modules": [
; "<string>",
; "<string>"
; ]
; },
; "id": "<string>",
; "type": "team",
; "relationships": {
; "team_links": {
; "data": [
; {
; "id": "<string>",
; "type": "team_links"
; },
; {
; "id": "<string>",
; "type": "team_links"
; }
; ],
; "links": {
; "related": "<string>"
; }
; },
; "user_team_permissions": {
; "data": {
; "id": "<string>",
; "type": "user_team_permissions"
; },
; "links": {
; "related": "<string>"
; }
; }
; }
; }
; ],
; "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"
; }
; ],
; "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
Local $sHandle
Local $sName
Local $sAvatar
Local $sBanner
Local $sCreated_at
Local $sDescription
Local $sLink_count
Local $sModified_at
Local $sSummary
Local $sUser_count
Local $sId
Local $sV_type
Local $sRelated
Local $sId
Local $sDataType
Local $sLinksRelated
Local $iJ
Local $iCount_j
Local $strVal
Local $sAttributesCreated_at
Local $sDisabled
Local $sV_Email
Local $sAttributesHandle
Local $sIcon
Local $sAttributesModified_at
Local $sAttributesName
Local $sService_account
Local $sStatus
Local $sTitle
Local $sVerified
Local $sDataId
Local $sFirst = $oJResp.StringOf("links.first")
Local $sLast = $oJResp.StringOf("links.last")
Local $sV_Next = $oJResp.StringOf("links.next")
Local $sPrev = $oJResp.StringOf("links.prev")
Local $sV_Self = $oJResp.StringOf("links.self")
Local $sFirst_offset = $oJResp.StringOf("meta.pagination.first_offset")
Local $sLast_offset = $oJResp.StringOf("meta.pagination.last_offset")
Local $sLimit = $oJResp.StringOf("meta.pagination.limit")
Local $sNext_offset = $oJResp.StringOf("meta.pagination.next_offset")
Local $sOffset = $oJResp.StringOf("meta.pagination.offset")
Local $sPrev_offset = $oJResp.StringOf("meta.pagination.prev_offset")
Local $sTotal = $oJResp.StringOf("meta.pagination.total")
Local $sV_Type = $oJResp.StringOf("meta.pagination.type")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sHandle = $oJResp.StringOf("data[i].attributes.handle")
$sName = $oJResp.StringOf("data[i].attributes.name")
$sAvatar = $oJResp.StringOf("data[i].attributes.avatar")
$sBanner = $oJResp.StringOf("data[i].attributes.banner")
$sCreated_at = $oJResp.StringOf("data[i].attributes.created_at")
$sDescription = $oJResp.StringOf("data[i].attributes.description")
$sLink_count = $oJResp.StringOf("data[i].attributes.link_count")
$sModified_at = $oJResp.StringOf("data[i].attributes.modified_at")
$sSummary = $oJResp.StringOf("data[i].attributes.summary")
$sUser_count = $oJResp.StringOf("data[i].attributes.user_count")
$sId = $oJResp.StringOf("data[i].id")
$sV_type = $oJResp.StringOf("data[i].type")
$sRelated = $oJResp.StringOf("data[i].relationships.team_links.links.related")
$sId = $oJResp.StringOf("data[i].relationships.user_team_permissions.data.id")
$sDataType = $oJResp.StringOf("data[i].relationships.user_team_permissions.data.type")
$sLinksRelated = $oJResp.StringOf("data[i].relationships.user_team_permissions.links.related")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attributes.hidden_modules")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].attributes.hidden_modules[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attributes.visible_modules")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].attributes.visible_modules[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].relationships.team_links.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("data[i].relationships.team_links.data[j].id")
$sV_type = $oJResp.StringOf("data[i].relationships.team_links.data[j].type")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("included")
While $i < $iCount_i
$oJResp.I = $i
$sAttributesCreated_at = $oJResp.StringOf("included[i].attributes.created_at")
$sDisabled = $oJResp.StringOf("included[i].attributes.disabled")
$sV_Email = $oJResp.StringOf("included[i].attributes.email")
$sAttributesHandle = $oJResp.StringOf("included[i].attributes.handle")
$sIcon = $oJResp.StringOf("included[i].attributes.icon")
$sAttributesModified_at = $oJResp.StringOf("included[i].attributes.modified_at")
$sAttributesName = $oJResp.StringOf("included[i].attributes.name")
$sService_account = $oJResp.StringOf("included[i].attributes.service_account")
$sStatus = $oJResp.StringOf("included[i].attributes.status")
$sTitle = $oJResp.StringOf("included[i].attributes.title")
$sVerified = $oJResp.StringOf("included[i].attributes.verified")
$sId = $oJResp.StringOf("included[i].id")
$sDataId = $oJResp.StringOf("included[i].relationships.org.data.id")
$sDataType = $oJResp.StringOf("included[i].relationships.org.data.type")
$sV_type = $oJResp.StringOf("included[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].relationships.other_orgs.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("included[i].relationships.other_orgs.data[j].id")
$sV_type = $oJResp.StringOf("included[i].relationships.other_orgs.data[j].type")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].relationships.other_users.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("included[i].relationships.other_users.data[j].id")
$sV_type = $oJResp.StringOf("included[i].relationships.other_users.data[j].type")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].relationships.roles.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("included[i].relationships.roles.data[j].id")
$sV_type = $oJResp.StringOf("included[i].relationships.roles.data[j].type")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -G -d "page[number]=0"
-d "page[size]=10"
-d "sort=user_count"
-d "include=user_team_permissions"
-d "include=team_links"
-d "filter[keyword]=%3Cstring%3E"
-d "filter[me]=%3Cboolean%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/team
Postman Collection Item JSON
{
"name": "Get all teams",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team?page[number]=0&page[size]=10&sort=user_count&include=user_team_permissions&include=team_links&filter[keyword]=<string>&filter[me]=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "sort",
"value": "user_count",
"description": "Specifies the order of the returned teams"
},
{
"key": "include",
"value": "user_team_permissions",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`"
},
{
"key": "include",
"value": "team_links",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`"
},
{
"key": "filter[keyword]",
"value": "<string>",
"description": "Search query. Can be team name, team handle, or email of team member"
},
{
"key": "filter[me]",
"value": "<boolean>",
"description": "When true, only returns teams the current user belongs to"
}
]
},
"description": "Get all teams.\nCan be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters."
},
"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/team?page[number]=0&page[size]=10&sort=user_count&include=team_links&filter[keyword]=<string>&filter[me]=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "sort",
"value": "user_count",
"description": "Specifies the order of the returned teams"
},
{
"key": "include",
"value": "team_links",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`"
},
{
"key": "filter[keyword]",
"value": "<string>",
"description": "Search query. Can be team name, team handle, or email of team member"
},
{
"key": "filter[me]",
"value": "<boolean>",
"description": "When true, only returns teams the current user belongs to"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"link_count\": \"<integer>\",\n \"modified_at\": \"<dateTime>\",\n \"summary\": \"<string>\",\n \"user_count\": \"<integer>\",\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"<string>\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"<string>\"\n }\n }\n }\n },\n {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"link_count\": \"<integer>\",\n \"modified_at\": \"<dateTime>\",\n \"summary\": \"<string>\",\n \"user_count\": \"<integer>\",\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"<string>\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"<string>\"\n }\n }\n }\n }\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 \"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": "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?page[number]=0&page[size]=10&sort=user_count&include=team_links&filter[keyword]=<string>&filter[me]=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "sort",
"value": "user_count",
"description": "Specifies the order of the returned teams"
},
{
"key": "include",
"value": "team_links",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`"
},
{
"key": "filter[keyword]",
"value": "<string>",
"description": "Search query. Can be team name, team handle, or email of team member"
},
{
"key": "filter[me]",
"value": "<boolean>",
"description": "When true, only returns teams the current user belongs to"
}
]
}
},
"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}"
}
]
}
