Chilkat Online Tools

Ruby / Datadog API Collection / Get all teams

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateInt("page[number]",0)
queryParams.UpdateInt("page[size]",10)
queryParams.UpdateString("sort","user_count")
queryParams.UpdateString("include","user_team_permissions")
queryParams.UpdateString("include","team_links")
queryParams.UpdateString("filter[keyword]","<string>")
queryParams.UpdateString("filter[me]","<boolean>")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/team",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

First = jResp.stringOf("links.first")
Last = jResp.stringOf("links.last")
v_Next = jResp.stringOf("links.next")
Prev = jResp.stringOf("links.prev")
v_Self = jResp.stringOf("links.self")
First_offset = jResp.stringOf("meta.pagination.first_offset")
Last_offset = jResp.stringOf("meta.pagination.last_offset")
Limit = jResp.stringOf("meta.pagination.limit")
Next_offset = jResp.stringOf("meta.pagination.next_offset")
Offset = jResp.stringOf("meta.pagination.offset")
Prev_offset = jResp.stringOf("meta.pagination.prev_offset")
Total = jResp.stringOf("meta.pagination.total")
v_Type = jResp.stringOf("meta.pagination.type")
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
    jResp.put_I(i)
    Handle = jResp.stringOf("data[i].attributes.handle")
    Name = jResp.stringOf("data[i].attributes.name")
    Avatar = jResp.stringOf("data[i].attributes.avatar")
    Banner = jResp.stringOf("data[i].attributes.banner")
    Created_at = jResp.stringOf("data[i].attributes.created_at")
    Description = jResp.stringOf("data[i].attributes.description")
    Link_count = jResp.stringOf("data[i].attributes.link_count")
    Modified_at = jResp.stringOf("data[i].attributes.modified_at")
    Summary = jResp.stringOf("data[i].attributes.summary")
    User_count = jResp.stringOf("data[i].attributes.user_count")
    id = jResp.stringOf("data[i].id")
    v_type = jResp.stringOf("data[i].type")
    Related = jResp.stringOf("data[i].relationships.team_links.links.related")
    Id = jResp.stringOf("data[i].relationships.user_team_permissions.data.id")
    DataType = jResp.stringOf("data[i].relationships.user_team_permissions.data.type")
    LinksRelated = jResp.stringOf("data[i].relationships.user_team_permissions.links.related")
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.hidden_modules")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("data[i].attributes.hidden_modules[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.visible_modules")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("data[i].attributes.visible_modules[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("data[i].relationships.team_links.data")
    while j < count_j
        jResp.put_J(j)
        id = jResp.stringOf("data[i].relationships.team_links.data[j].id")
        v_type = jResp.stringOf("data[i].relationships.team_links.data[j].type")
        j = j + 1
    end
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("included")
while i < count_i
    jResp.put_I(i)
    attributesCreated_at = jResp.stringOf("included[i].attributes.created_at")
    Disabled = jResp.stringOf("included[i].attributes.disabled")
    v_Email = jResp.stringOf("included[i].attributes.email")
    attributesHandle = jResp.stringOf("included[i].attributes.handle")
    Icon = jResp.stringOf("included[i].attributes.icon")
    attributesModified_at = jResp.stringOf("included[i].attributes.modified_at")
    attributesName = jResp.stringOf("included[i].attributes.name")
    Service_account = jResp.stringOf("included[i].attributes.service_account")
    Status = jResp.stringOf("included[i].attributes.status")
    Title = jResp.stringOf("included[i].attributes.title")
    Verified = jResp.stringOf("included[i].attributes.verified")
    id = jResp.stringOf("included[i].id")
    DataId = jResp.stringOf("included[i].relationships.org.data.id")
    DataType = jResp.stringOf("included[i].relationships.org.data.type")
    v_type = jResp.stringOf("included[i].type")
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.other_orgs.data")
    while j < count_j
        jResp.put_J(j)
        id = jResp.stringOf("included[i].relationships.other_orgs.data[j].id")
        v_type = jResp.stringOf("included[i].relationships.other_orgs.data[j].type")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.other_users.data")
    while j < count_j
        jResp.put_J(j)
        id = jResp.stringOf("included[i].relationships.other_users.data[j].id")
        v_type = jResp.stringOf("included[i].relationships.other_users.data[j].type")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.roles.data")
    while j < count_j
        jResp.put_J(j)
        id = jResp.stringOf("included[i].relationships.roles.data[j].id")
        v_type = jResp.stringOf("included[i].relationships.roles.data[j].type")
        j = j + 1
    end
    i = i + 1
end

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}"
    }
  ]
}