Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// 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"
// }
// ]
// }
// }
// }
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("data.attributes.handle","<string>")
success = json.UpdateString("data.attributes.name","<string>")
success = json.UpdateString("data.attributes.avatar","<string>")
success = json.UpdateString("data.attributes.banner","<long>")
success = json.UpdateString("data.attributes.description","<string>")
success = json.UpdateString("data.attributes.hidden_modules[0]","<string>")
success = json.UpdateString("data.attributes.hidden_modules[1]","<string>")
success = json.UpdateString("data.attributes.visible_modules[0]","<string>")
success = json.UpdateString("data.attributes.visible_modules[1]","<string>")
success = json.UpdateString("data.type","team")
success = json.UpdateString("data.relationships.users.data[0].id","<string>")
success = json.UpdateString("data.relationships.users.data[0].type","users")
success = json.UpdateString("data.relationships.users.data[1].id","<string>")
success = json.UpdateString("data.relationships.users.data[1].type","users")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/team","application/json",json)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim strVal As String
Dim id As String
Dim v_type As String
Dim Handle As String
Handle = jResp.StringOf("data.attributes.handle")
Dim Name As String
Name = jResp.StringOf("data.attributes.name")
Dim Avatar As String
Avatar = jResp.StringOf("data.attributes.avatar")
Dim Banner As String
Banner = jResp.StringOf("data.attributes.banner")
Dim Created_at As String
Created_at = jResp.StringOf("data.attributes.created_at")
Dim Description As String
Description = jResp.StringOf("data.attributes.description")
Dim Link_count As String
Link_count = jResp.StringOf("data.attributes.link_count")
Dim Modified_at As String
Modified_at = jResp.StringOf("data.attributes.modified_at")
Dim Summary As String
Summary = jResp.StringOf("data.attributes.summary")
Dim User_count As String
User_count = jResp.StringOf("data.attributes.user_count")
Dim Id As String
Id = jResp.StringOf("data.id")
Dim v_Type As String
v_Type = jResp.StringOf("data.type")
Dim Related As String
Related = jResp.StringOf("data.relationships.team_links.links.related")
Dim DataId As String
DataId = jResp.StringOf("data.relationships.user_team_permissions.data.id")
Dim DataType As String
DataType = jResp.StringOf("data.relationships.user_team_permissions.data.type")
Dim LinksRelated As String
LinksRelated = jResp.StringOf("data.relationships.user_team_permissions.links.related")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("data.attributes.hidden_modules")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("data.attributes.hidden_modules[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("data.attributes.visible_modules")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("data.attributes.visible_modules[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("data.relationships.team_links.data")
While i < 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
Wend
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}"
}
]
}