Chilkat Online Tools

Xojo / Datadog API Collection / Get team memberships

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

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateInt("page[size]",10)
success = queryParams.UpdateInt("page[number]",0)
success = queryParams.UpdateString("sort","email")
success = queryParams.UpdateString("filter[keyword]","<string>")

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

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/team/:team_id/memberships",queryParams)
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": [
//     {
//       "id": "<string>",
//       "type": "team_memberships",
//       "attributes": {
//         "role": "admin"
//       },
//       "relationships": {
//         "user": {
//           "data": {
//             "id": "<string>",
//             "type": "users"
//           }
//         }
//       }
//     },
//     {
//       "id": "<string>",
//       "type": "team_memberships",
//       "attributes": {
//         "role": "admin"
//       },
//       "relationships": {
//         "user": {
//           "data": {
//             "id": "<string>",
//             "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

Dim id As String
Dim v_type As String
Dim Role As String
Dim Id As String
Dim DataType As String

Dim First As String
First = jResp.StringOf("links.first")
Dim Last As String
Last = jResp.StringOf("links.last")
Dim v_Next As String
v_Next = jResp.StringOf("links.next")
Dim Prev As String
Prev = jResp.StringOf("links.prev")
Dim v_Self As String
v_Self = jResp.StringOf("links.self")
Dim First_offset As String
First_offset = jResp.StringOf("meta.pagination.first_offset")
Dim Last_offset As String
Last_offset = jResp.StringOf("meta.pagination.last_offset")
Dim Limit As String
Limit = jResp.StringOf("meta.pagination.limit")
Dim Next_offset As String
Next_offset = jResp.StringOf("meta.pagination.next_offset")
Dim Offset As String
Offset = jResp.StringOf("meta.pagination.offset")
Dim Prev_offset As String
Prev_offset = jResp.StringOf("meta.pagination.prev_offset")
Dim Total As String
Total = jResp.StringOf("meta.pagination.total")
Dim v_Type As String
v_Type = jResp.StringOf("meta.pagination.type")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("data")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("data[i].id")
    v_type = jResp.StringOf("data[i].type")
    Role = jResp.StringOf("data[i].attributes.role")
    Id = jResp.StringOf("data[i].relationships.user.data.id")
    DataType = jResp.StringOf("data[i].relationships.user.data.type")
    i = i + 1
Wend

Curl Command

curl -G -d "page[size]=10"
	-d "page[number]=0"
	-d "sort=email"
	-d "filter[keyword]=%3Cstring%3E"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/team/:team_id/memberships

Postman Collection Item JSON

{
  "name": "Get team memberships",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/team/:team_id/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "team",
        ":team_id",
        "memberships"
      ],
      "query": [
        {
          "key": "page[size]",
          "value": "10",
          "description": "Size for a given page. The maximum allowed value is 100."
        },
        {
          "key": "page[number]",
          "value": "0",
          "description": "Specific page number to return."
        },
        {
          "key": "sort",
          "value": "email",
          "description": "Specifies the order of returned team memberships"
        },
        {
          "key": "filter[keyword]",
          "value": "<string>",
          "description": "Search query, can be user email or name"
        }
      ],
      "variable": [
        {
          "key": "team_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get a paginated list of members for a team"
  },
  "response": [
    {
      "name": "Represents a user's association to a team",
      "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/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "team",
            ":team_id",
            "memberships"
          ],
          "query": [
            {
              "key": "page[size]",
              "value": "10",
              "description": "Size for a given page. The maximum allowed value is 100."
            },
            {
              "key": "page[number]",
              "value": "0",
              "description": "Specific page number to return."
            },
            {
              "key": "sort",
              "value": "email",
              "description": "Specifies the order of returned team memberships"
            },
            {
              "key": "filter[keyword]",
              "value": "<string>",
              "description": "Search query, can be user email or name"
            }
          ],
          "variable": [
            {
              "key": "team_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"team_memberships\",\n      \"attributes\": {\n        \"role\": \"admin\"\n      },\n      \"relationships\": {\n        \"user\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        }\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"type\": \"team_memberships\",\n      \"attributes\": {\n        \"role\": \"admin\"\n      },\n      \"relationships\": {\n        \"user\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        }\n      }\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": "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/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "team",
            ":team_id",
            "memberships"
          ],
          "query": [
            {
              "key": "page[size]",
              "value": "10",
              "description": "Size for a given page. The maximum allowed value is 100."
            },
            {
              "key": "page[number]",
              "value": "0",
              "description": "Specific page number to return."
            },
            {
              "key": "sort",
              "value": "email",
              "description": "Specifies the order of returned team memberships"
            },
            {
              "key": "filter[keyword]",
              "value": "<string>",
              "description": "Search query, can be user email or name"
            }
          ],
          "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/memberships?page[size]=10&page[number]=0&sort=email&filter[keyword]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "team",
            ":team_id",
            "memberships"
          ],
          "query": [
            {
              "key": "page[size]",
              "value": "10",
              "description": "Size for a given page. The maximum allowed value is 100."
            },
            {
              "key": "page[number]",
              "value": "0",
              "description": "Specific page number to return."
            },
            {
              "key": "sort",
              "value": "email",
              "description": "Specifies the order of returned team memberships"
            },
            {
              "key": "filter[keyword]",
              "value": "<string>",
              "description": "Search query, can be user email or name"
            }
          ],
          "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}"
    }
  ]
}