Chilkat Online Tools

C++ / Datadog API Collection / Get team memberships

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateInt("page[size]",10);
    queryParams.UpdateInt("page[number]",0);
    queryParams.UpdateString("sort","email");
    queryParams.UpdateString("filter[keyword]","<string>");

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

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/team/:team_id/memberships",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *v_type = 0;
    const char *Role = 0;
    const char *Id = 0;
    const char *DataType = 0;

    const char *First = jResp.stringOf("links.first");
    const char *Last = jResp.stringOf("links.last");
    const char *v_Next = jResp.stringOf("links.next");
    const char *Prev = jResp.stringOf("links.prev");
    const char *v_Self = jResp.stringOf("links.self");
    const char *First_offset = jResp.stringOf("meta.pagination.first_offset");
    const char *Last_offset = jResp.stringOf("meta.pagination.last_offset");
    const char *Limit = jResp.stringOf("meta.pagination.limit");
    const char *Next_offset = jResp.stringOf("meta.pagination.next_offset");
    const char *Offset = jResp.stringOf("meta.pagination.offset");
    const char *Prev_offset = jResp.stringOf("meta.pagination.prev_offset");
    const char *Total = jResp.stringOf("meta.pagination.total");
    const char *v_Type = jResp.stringOf("meta.pagination.type");
    int i = 0;
    int count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.put_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;
    }
    }

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