Chilkat Online Tools

lianja / Datadog API Collection / Get user memberships

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/users/:user_uuid/memberships",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

lcFirst = loJResp.StringOf("links.first")
lcLast = loJResp.StringOf("links.last")
lcV_Next = loJResp.StringOf("links.next")
lcPrev = loJResp.StringOf("links.prev")
lcV_Self = loJResp.StringOf("links.self")
lcFirst_offset = loJResp.StringOf("meta.pagination.first_offset")
lcLast_offset = loJResp.StringOf("meta.pagination.last_offset")
lcLimit = loJResp.StringOf("meta.pagination.limit")
lcNext_offset = loJResp.StringOf("meta.pagination.next_offset")
lcOffset = loJResp.StringOf("meta.pagination.offset")
lcPrev_offset = loJResp.StringOf("meta.pagination.prev_offset")
lcTotal = loJResp.StringOf("meta.pagination.total")
lcV_Type = loJResp.StringOf("meta.pagination.type")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data[i].id")
    lcV_type = loJResp.StringOf("data[i].type")
    lcRole = loJResp.StringOf("data[i].attributes.role")
    lcId = loJResp.StringOf("data[i].relationships.user.data.id")
    lcDataType = loJResp.StringOf("data[i].relationships.user.data.type")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/users/:user_uuid/memberships

Postman Collection Item JSON

{
  "name": "Get user memberships",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_uuid",
        "memberships"
      ],
      "variable": [
        {
          "key": "user_uuid",
          "value": "<string>"
        }
      ]
    },
    "description": "Get a list of memberships for a user"
  },
  "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/users/:user_uuid/memberships",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_uuid",
            "memberships"
          ],
          "variable": [
            {
              "key": "user_uuid"
            }
          ]
        }
      },
      "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/users/:user_uuid/memberships",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_uuid",
            "memberships"
          ],
          "variable": [
            {
              "key": "user_uuid"
            }
          ]
        }
      },
      "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/users/:user_uuid/memberships",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_uuid",
            "memberships"
          ],
          "variable": [
            {
              "key": "user_uuid"
            }
          ]
        }
      },
      "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}"
    }
  ]
}