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
# 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": {
# "attributes": {
# "handle": "<string>",
# "name": "<string>",
# "avatar": "<string>",
# "banner": "<long>",
# "description": "<string>",
# "hidden_modules": [
# "<string>",
# "<string>"
# ],
# "visible_modules": [
# "<string>",
# "<string>"
# ]
# },
# "type": "team",
# "relationships": {
# "users": {
# "data": [
# {
# "id": "<string>",
# "type": "users"
# },
# {
# "id": "<string>",
# "type": "users"
# }
# ]
# }
# }
# }
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("data.attributes.handle","<string>")
$json.UpdateString("data.attributes.name","<string>")
$json.UpdateString("data.attributes.avatar","<string>")
$json.UpdateString("data.attributes.banner","<long>")
$json.UpdateString("data.attributes.description","<string>")
$json.UpdateString("data.attributes.hidden_modules[0]","<string>")
$json.UpdateString("data.attributes.hidden_modules[1]","<string>")
$json.UpdateString("data.attributes.visible_modules[0]","<string>")
$json.UpdateString("data.attributes.visible_modules[1]","<string>")
$json.UpdateString("data.type","team")
$json.UpdateString("data.relationships.users.data[0].id","<string>")
$json.UpdateString("data.relationships.users.data[0].type","users")
$json.UpdateString("data.relationships.users.data[1].id","<string>")
$json.UpdateString("data.relationships.users.data[1].type","users")
$http.SetRequestHeader("Content-Type","application/json")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.PostJson3("https://api.app.ddog-gov.com/api/v2/team","application/json",$json)
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": {
# "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>"
# }
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Handle = $jResp.StringOf("data.attributes.handle")
$Name = $jResp.StringOf("data.attributes.name")
$Avatar = $jResp.StringOf("data.attributes.avatar")
$Banner = $jResp.StringOf("data.attributes.banner")
$Created_at = $jResp.StringOf("data.attributes.created_at")
$Description = $jResp.StringOf("data.attributes.description")
$Link_count = $jResp.StringOf("data.attributes.link_count")
$Modified_at = $jResp.StringOf("data.attributes.modified_at")
$Summary = $jResp.StringOf("data.attributes.summary")
$User_count = $jResp.StringOf("data.attributes.user_count")
$Id = $jResp.StringOf("data.id")
$v_Type = $jResp.StringOf("data.type")
$Related = $jResp.StringOf("data.relationships.team_links.links.related")
$DataId = $jResp.StringOf("data.relationships.user_team_permissions.data.id")
$DataType = $jResp.StringOf("data.relationships.user_team_permissions.data.type")
$LinksRelated = $jResp.StringOf("data.relationships.user_team_permissions.links.related")
$i = 0
$count_i = $jResp.SizeOfArray("data.attributes.hidden_modules")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("data.attributes.hidden_modules[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("data.attributes.visible_modules")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("data.attributes.visible_modules[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("data.relationships.team_links.data")
while ($i -lt $count_i) {
$jResp.I = $i
$id = $jResp.StringOf("data.relationships.team_links.data[i].id")
$v_type = $jResp.StringOf("data.relationships.team_links.data[i].type")
$i = $i + 1
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"handle": "<string>",
"name": "<string>",
"avatar": "<string>",
"banner": "<long>",
"description": "<string>",
"hidden_modules": [
"<string>",
"<string>"
],
"visible_modules": [
"<string>",
"<string>"
]
},
"type": "team",
"relationships": {
"users": {
"data": [
{
"id": "<string>",
"type": "users"
},
{
"id": "<string>",
"type": "users"
}
]
}
}
}
}'
https://api.app.ddog-gov.com/api/v2/team
Postman Collection Item JSON
{
"name": "Create a team",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
},
"description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"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 \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "POST",
"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 \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Conflict",
"code": 409,
"_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": "POST",
"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 \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"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}"
}
]
}
