Chilkat Online Tools

Swift3 / Datadog API Collection / Get all teams

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

    let queryParams = CkoJsonObject()!
    queryParams.updateInt("page[number]", value: 0)
    queryParams.updateInt("page[size]", value: 10)
    queryParams.update("sort", value: "user_count")
    queryParams.update("include", value: "user_team_permissions")
    queryParams.update("include", value: "team_links")
    queryParams.update("filter[keyword]", value: "<string>")
    queryParams.update("filter[me]", value: "<boolean>")

    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v2/team", json: queryParams)
    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>"
    //           }
    //         }
    //       }
    //     },
    //     {
    //       "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

    var Handle: String?
    var Name: String?
    var Avatar: String?
    var Banner: String?
    var Created_at: String?
    var Description: String?
    var Link_count: String?
    var Modified_at: String?
    var Summary: String?
    var User_count: String?
    var id: String?
    var v_type: String?
    var Related: String?
    var Id: String?
    var DataType: String?
    var LinksRelated: String?
    var j: Int
    var count_j: Int
    var strVal: String?
    var attributesCreated_at: String?
    var Disabled: String?
    var v_Email: String?
    var attributesHandle: String?
    var Icon: String?
    var attributesModified_at: String?
    var attributesName: String?
    var Service_account: String?
    var Status: String?
    var Title: String?
    var Verified: String?
    var DataId: String?

    var First: String? = jResp.string(of: "links.first")
    var Last: String? = jResp.string(of: "links.last")
    var v_Next: String? = jResp.string(of: "links.next")
    var Prev: String? = jResp.string(of: "links.prev")
    var v_Self: String? = jResp.string(of: "links.self")
    var First_offset: String? = jResp.string(of: "meta.pagination.first_offset")
    var Last_offset: String? = jResp.string(of: "meta.pagination.last_offset")
    var Limit: String? = jResp.string(of: "meta.pagination.limit")
    var Next_offset: String? = jResp.string(of: "meta.pagination.next_offset")
    var Offset: String? = jResp.string(of: "meta.pagination.offset")
    var Prev_offset: String? = jResp.string(of: "meta.pagination.prev_offset")
    var Total: String? = jResp.string(of: "meta.pagination.total")
    var v_Type: String? = jResp.string(of: "meta.pagination.type")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data").intValue
    while i < count_i {
        jResp.i = i
        Handle = jResp.string(of: "data[i].attributes.handle")
        Name = jResp.string(of: "data[i].attributes.name")
        Avatar = jResp.string(of: "data[i].attributes.avatar")
        Banner = jResp.string(of: "data[i].attributes.banner")
        Created_at = jResp.string(of: "data[i].attributes.created_at")
        Description = jResp.string(of: "data[i].attributes.description")
        Link_count = jResp.string(of: "data[i].attributes.link_count")
        Modified_at = jResp.string(of: "data[i].attributes.modified_at")
        Summary = jResp.string(of: "data[i].attributes.summary")
        User_count = jResp.string(of: "data[i].attributes.user_count")
        id = jResp.string(of: "data[i].id")
        v_type = jResp.string(of: "data[i].type")
        Related = jResp.string(of: "data[i].relationships.team_links.links.related")
        Id = jResp.string(of: "data[i].relationships.user_team_permissions.data.id")
        DataType = jResp.string(of: "data[i].relationships.user_team_permissions.data.type")
        LinksRelated = jResp.string(of: "data[i].relationships.user_team_permissions.links.related")
        j = 0
        count_j = jResp.size(ofArray: "data[i].attributes.hidden_modules").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "data[i].attributes.hidden_modules[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "data[i].attributes.visible_modules").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "data[i].attributes.visible_modules[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "data[i].relationships.team_links.data").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "data[i].relationships.team_links.data[j].id")
            v_type = jResp.string(of: "data[i].relationships.team_links.data[j].type")
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "included").intValue
    while i < count_i {
        jResp.i = i
        attributesCreated_at = jResp.string(of: "included[i].attributes.created_at")
        Disabled = jResp.string(of: "included[i].attributes.disabled")
        v_Email = jResp.string(of: "included[i].attributes.email")
        attributesHandle = jResp.string(of: "included[i].attributes.handle")
        Icon = jResp.string(of: "included[i].attributes.icon")
        attributesModified_at = jResp.string(of: "included[i].attributes.modified_at")
        attributesName = jResp.string(of: "included[i].attributes.name")
        Service_account = jResp.string(of: "included[i].attributes.service_account")
        Status = jResp.string(of: "included[i].attributes.status")
        Title = jResp.string(of: "included[i].attributes.title")
        Verified = jResp.string(of: "included[i].attributes.verified")
        id = jResp.string(of: "included[i].id")
        DataId = jResp.string(of: "included[i].relationships.org.data.id")
        DataType = jResp.string(of: "included[i].relationships.org.data.type")
        v_type = jResp.string(of: "included[i].type")
        j = 0
        count_j = jResp.size(ofArray: "included[i].relationships.other_orgs.data").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "included[i].relationships.other_orgs.data[j].id")
            v_type = jResp.string(of: "included[i].relationships.other_orgs.data[j].type")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "included[i].relationships.other_users.data").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "included[i].relationships.other_users.data[j].id")
            v_type = jResp.string(of: "included[i].relationships.other_users.data[j].type")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "included[i].relationships.roles.data").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "included[i].relationships.roles.data[j].id")
            v_type = jResp.string(of: "included[i].relationships.roles.data[j].type")
            j = j + 1
        }

        i = i + 1
    }


}

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