Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
// 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>",
// "color": "<integer>",
// "description": "<string>",
// "hidden_modules": [
// "<string>",
// "<string>"
// ],
// "visible_modules": [
// "<string>",
// "<string>"
// ]
// },
// "type": "team",
// "relationships": {
// "team_links": {
// "data": [
// {
// "id": "<string>",
// "type": "team_links"
// },
// {
// "id": "<string>",
// "type": "team_links"
// }
// ],
// "links": {
// "related": "<string>"
// }
// }
// }
// }
// }
let json = CkoJsonObject()
json.UpdateString("data.attributes.handle", value: "<string>")
json.UpdateString("data.attributes.name", value: "<string>")
json.UpdateString("data.attributes.avatar", value: "<string>")
json.UpdateString("data.attributes.banner", value: "<long>")
json.UpdateString("data.attributes.color", value: "<integer>")
json.UpdateString("data.attributes.description", value: "<string>")
json.UpdateString("data.attributes.hidden_modules[0]", value: "<string>")
json.UpdateString("data.attributes.hidden_modules[1]", value: "<string>")
json.UpdateString("data.attributes.visible_modules[0]", value: "<string>")
json.UpdateString("data.attributes.visible_modules[1]", value: "<string>")
json.UpdateString("data.type", value: "team")
json.UpdateString("data.relationships.team_links.data[0].id", value: "<string>")
json.UpdateString("data.relationships.team_links.data[0].type", value: "team_links")
json.UpdateString("data.relationships.team_links.data[1].id", value: "<string>")
json.UpdateString("data.relationships.team_links.data[1].type", value: "team_links")
json.UpdateString("data.relationships.team_links.links.related", value: "<string>")
http.SetRequestHeader("Content-Type", value: "application/json")
http.SetRequestHeader("Accept", value: "application/json")
let sbRequestBody = CkoStringBuilder()
json.EmitSb(sbRequestBody)
var resp: CkoHttpResponse? = http.PTextSb("PATCH", url: "https://api.app.ddog-gov.com/api/v2/team/:team_id", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var strVal: String?
var id: String?
var v_type: String?
var Handle: String? = jResp.StringOf("data.attributes.handle")
var Name: String? = jResp.StringOf("data.attributes.name")
var Avatar: String? = jResp.StringOf("data.attributes.avatar")
var Banner: String? = jResp.StringOf("data.attributes.banner")
var Created_at: String? = jResp.StringOf("data.attributes.created_at")
var Description: String? = jResp.StringOf("data.attributes.description")
var Link_count: String? = jResp.StringOf("data.attributes.link_count")
var Modified_at: String? = jResp.StringOf("data.attributes.modified_at")
var Summary: String? = jResp.StringOf("data.attributes.summary")
var User_count: String? = jResp.StringOf("data.attributes.user_count")
var Id: String? = jResp.StringOf("data.id")
var v_Type: String? = jResp.StringOf("data.type")
var Related: String? = jResp.StringOf("data.relationships.team_links.links.related")
var DataId: String? = jResp.StringOf("data.relationships.user_team_permissions.data.id")
var DataType: String? = jResp.StringOf("data.relationships.user_team_permissions.data.type")
var LinksRelated: String? = jResp.StringOf("data.relationships.user_team_permissions.links.related")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("data.attributes.hidden_modules").intValue
while i < 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").intValue
while i < 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").intValue
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
}
}
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"handle": "<string>",
"name": "<string>",
"avatar": "<string>",
"banner": "<long>",
"color": "<integer>",
"description": "<string>",
"hidden_modules": [
"<string>",
"<string>"
],
"visible_modules": [
"<string>",
"<string>"
]
},
"type": "team",
"relationships": {
"team_links": {
"data": [
{
"id": "<string>",
"type": "team_links"
},
{
"id": "<string>",
"type": "team_links"
}
],
"links": {
"related": "<string>"
}
}
}
}
}'
https://api.app.ddog-gov.com/api/v2/team/:team_id
Postman Collection Item JSON
{
"name": "Update a team",
"request": {
"method": "PATCH",
"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 \"color\": \"<integer>\",\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 \"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 }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id",
"value": "<string>"
}
]
},
"description": "Update a team using the team's `id`.\nIf the `team_links` relationship is present, the associated links are updated to be in the order they appear in the array, and any existing team links not present are removed."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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 \"color\": \"<integer>\",\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 \"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 }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_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": "PATCH",
"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 \"color\": \"<integer>\",\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 \"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 }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "PATCH",
"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 \"color\": \"<integer>\",\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 \"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 }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"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": "API error response.",
"originalRequest": {
"method": "PATCH",
"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 \"color\": \"<integer>\",\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 \"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 }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"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": "PATCH",
"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 \"color\": \"<integer>\",\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 \"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 }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"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}"
}
]
}
