Chilkat Online Tools

PureBasic / Datadog API Collection / Get user details

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v2/users/:user_id",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "data": {
    ;     "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"
    ;   },
    ;   "included": [
    ;     {
    ;       "type": "orgs",
    ;       "attributes": {
    ;         "created_at": "<dateTime>",
    ;         "description": "<string>",
    ;         "disabled": "<boolean>",
    ;         "modified_at": "<dateTime>",
    ;         "name": "<string>",
    ;         "public_id": "<string>",
    ;         "sharing": "<string>",
    ;         "url": "<string>"
    ;       },
    ;       "id": "<string>"
    ;     },
    ;     {
    ;       "type": "orgs",
    ;       "attributes": {
    ;         "created_at": "<dateTime>",
    ;         "description": "<string>",
    ;         "disabled": "<boolean>",
    ;         "modified_at": "<dateTime>",
    ;         "name": "<string>",
    ;         "public_id": "<string>",
    ;         "sharing": "<string>",
    ;         "url": "<string>"
    ;       },
    ;       "id": "<string>"
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    id.s
    v_type.s
    attributesCreated_at.s
    Description.s
    attributesDisabled.s
    attributesModified_at.s
    attributesName.s
    Public_id.s
    Sharing.s
    v_Url.s

    Created_at.s = CkJsonObject::ckStringOf(jResp,"data.attributes.created_at")
    Disabled.s = CkJsonObject::ckStringOf(jResp,"data.attributes.disabled")
    v_Email.s = CkJsonObject::ckStringOf(jResp,"data.attributes.email")
    Handle.s = CkJsonObject::ckStringOf(jResp,"data.attributes.handle")
    Icon.s = CkJsonObject::ckStringOf(jResp,"data.attributes.icon")
    Modified_at.s = CkJsonObject::ckStringOf(jResp,"data.attributes.modified_at")
    Name.s = CkJsonObject::ckStringOf(jResp,"data.attributes.name")
    Service_account.s = CkJsonObject::ckStringOf(jResp,"data.attributes.service_account")
    Status.s = CkJsonObject::ckStringOf(jResp,"data.attributes.status")
    Title.s = CkJsonObject::ckStringOf(jResp,"data.attributes.title")
    Verified.s = CkJsonObject::ckStringOf(jResp,"data.attributes.verified")
    Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
    DataId.s = CkJsonObject::ckStringOf(jResp,"data.relationships.org.data.id")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"data.relationships.org.data.type")
    dataType.s = CkJsonObject::ckStringOf(jResp,"data.type")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.relationships.other_orgs.data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"data.relationships.other_orgs.data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data.relationships.other_orgs.data[i].type")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"data.relationships.other_users.data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"data.relationships.other_users.data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data.relationships.other_users.data[i].type")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"data.relationships.roles.data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"data.relationships.roles.data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data.relationships.roles.data[i].type")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"included")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        v_type = CkJsonObject::ckStringOf(jResp,"included[i].type")
        attributesCreated_at = CkJsonObject::ckStringOf(jResp,"included[i].attributes.created_at")
        Description = CkJsonObject::ckStringOf(jResp,"included[i].attributes.description")
        attributesDisabled = CkJsonObject::ckStringOf(jResp,"included[i].attributes.disabled")
        attributesModified_at = CkJsonObject::ckStringOf(jResp,"included[i].attributes.modified_at")
        attributesName = CkJsonObject::ckStringOf(jResp,"included[i].attributes.name")
        Public_id = CkJsonObject::ckStringOf(jResp,"included[i].attributes.public_id")
        Sharing = CkJsonObject::ckStringOf(jResp,"included[i].attributes.sharing")
        v_Url = CkJsonObject::ckStringOf(jResp,"included[i].attributes.url")
        id = CkJsonObject::ckStringOf(jResp,"included[i].id")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get user details",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get a user in the organization specified by the user’s `user_id`."
  },
  "response": [
    {
      "name": "OK for get user",
      "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_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\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  \"included\": [\n    {\n      \"type\": \"orgs\",\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"description\": \"<string>\",\n        \"disabled\": \"<boolean>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"sharing\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"orgs\",\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"description\": \"<string>\",\n        \"disabled\": \"<boolean>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"sharing\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Authentication error",
      "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_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Not found",
      "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_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_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/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_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}"
    }
  ]
}