Chilkat Online Tools

TCL / Datadog API Collection / Get a team

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v2/team/:team_id" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    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

set Handle [CkJsonObject_stringOf $jResp "data.attributes.handle"]
set Name [CkJsonObject_stringOf $jResp "data.attributes.name"]
set Avatar [CkJsonObject_stringOf $jResp "data.attributes.avatar"]
set Banner [CkJsonObject_stringOf $jResp "data.attributes.banner"]
set Created_at [CkJsonObject_stringOf $jResp "data.attributes.created_at"]
set Description [CkJsonObject_stringOf $jResp "data.attributes.description"]
set Link_count [CkJsonObject_stringOf $jResp "data.attributes.link_count"]
set Modified_at [CkJsonObject_stringOf $jResp "data.attributes.modified_at"]
set Summary [CkJsonObject_stringOf $jResp "data.attributes.summary"]
set User_count [CkJsonObject_stringOf $jResp "data.attributes.user_count"]
set Id [CkJsonObject_stringOf $jResp "data.id"]
set v_Type [CkJsonObject_stringOf $jResp "data.type"]
set Related [CkJsonObject_stringOf $jResp "data.relationships.team_links.links.related"]
set DataId [CkJsonObject_stringOf $jResp "data.relationships.user_team_permissions.data.id"]
set DataType [CkJsonObject_stringOf $jResp "data.relationships.user_team_permissions.data.type"]
set LinksRelated [CkJsonObject_stringOf $jResp "data.relationships.user_team_permissions.links.related"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.attributes.hidden_modules"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "data.attributes.hidden_modules[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.attributes.visible_modules"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "data.attributes.visible_modules[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.relationships.team_links.data"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set id [CkJsonObject_stringOf $jResp "data.relationships.team_links.data[i].id"]
    set v_type [CkJsonObject_stringOf $jResp "data.relationships.team_links.data[i].type"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/team/:team_id

Postman Collection Item JSON

{
  "name": "Get a team",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/team/:team_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "team",
        ":team_id"
      ],
      "variable": [
        {
          "key": "team_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get a single team using the team's `id`."
  },
  "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/: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": "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",
          "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": "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",
          "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}"
    }
  ]
}