Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *strVal;
const char *attributesCreated_at;
const char *Disabled;
const char *v_Email;
const char *Handle;
const char *Icon;
const char *Modified_at;
const char *attributesName;
const char *Service_account;
const char *Status;
const char *Title;
const char *Verified;
const char *id;
const char *DataType;
const char *v_type;
int j;
int count_j;
const char *Created_at;
const char *Key;
const char *Last4;
const char *Name;
const char *Id;
const char *DataId;
const char *v_Type;
const char *dataType;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"include","<string>");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_QuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v2/application_keys/:app_key_id",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "created_at": "<string>",
// "key": "<string>",
// "last4": "<string>",
// "name": "<string>",
// "scopes": [
// "<string>",
// "<string>"
// ]
// },
// "id": "<string>",
// "relationships": {
// "owned_by": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// },
// "type": "application_keys"
// },
// "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"
// }
// ]
// }
// 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.
Created_at = CkJsonObject_stringOf(jResp,"data.attributes.created_at");
Key = CkJsonObject_stringOf(jResp,"data.attributes.key");
Last4 = CkJsonObject_stringOf(jResp,"data.attributes.last4");
Name = CkJsonObject_stringOf(jResp,"data.attributes.name");
Id = CkJsonObject_stringOf(jResp,"data.id");
DataId = CkJsonObject_stringOf(jResp,"data.relationships.owned_by.data.id");
v_Type = CkJsonObject_stringOf(jResp,"data.relationships.owned_by.data.type");
dataType = CkJsonObject_stringOf(jResp,"data.type");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"data.attributes.scopes");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"data.attributes.scopes[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"included");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
attributesCreated_at = CkJsonObject_stringOf(jResp,"included[i].attributes.created_at");
Disabled = CkJsonObject_stringOf(jResp,"included[i].attributes.disabled");
v_Email = CkJsonObject_stringOf(jResp,"included[i].attributes.email");
Handle = CkJsonObject_stringOf(jResp,"included[i].attributes.handle");
Icon = CkJsonObject_stringOf(jResp,"included[i].attributes.icon");
Modified_at = CkJsonObject_stringOf(jResp,"included[i].attributes.modified_at");
attributesName = CkJsonObject_stringOf(jResp,"included[i].attributes.name");
Service_account = CkJsonObject_stringOf(jResp,"included[i].attributes.service_account");
Status = CkJsonObject_stringOf(jResp,"included[i].attributes.status");
Title = CkJsonObject_stringOf(jResp,"included[i].attributes.title");
Verified = CkJsonObject_stringOf(jResp,"included[i].attributes.verified");
id = CkJsonObject_stringOf(jResp,"included[i].id");
DataId = CkJsonObject_stringOf(jResp,"included[i].relationships.org.data.id");
DataType = CkJsonObject_stringOf(jResp,"included[i].relationships.org.data.type");
v_type = CkJsonObject_stringOf(jResp,"included[i].type");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"included[i].relationships.other_orgs.data");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
id = CkJsonObject_stringOf(jResp,"included[i].relationships.other_orgs.data[j].id");
v_type = CkJsonObject_stringOf(jResp,"included[i].relationships.other_orgs.data[j].type");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"included[i].relationships.other_users.data");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
id = CkJsonObject_stringOf(jResp,"included[i].relationships.other_users.data[j].id");
v_type = CkJsonObject_stringOf(jResp,"included[i].relationships.other_users.data[j].type");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"included[i].relationships.roles.data");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
id = CkJsonObject_stringOf(jResp,"included[i].relationships.roles.data[j].id");
v_type = CkJsonObject_stringOf(jResp,"included[i].relationships.roles.data[j].type");
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -G -d "include=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/application_keys/:app_key_id
Postman Collection Item JSON
{
"name": "Get an application key",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported."
}
],
"variable": [
{
"key": "app_key_id",
"value": "<string>"
}
]
},
"description": "Get an application key for your org."
},
"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/application_keys/:app_key_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported."
}
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"<string>\",\n \"key\": \"<string>\",\n \"last4\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\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}"
},
{
"name": "Bad Request",
"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/application_keys/:app_key_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported."
}
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Forbidden",
"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/application_keys/:app_key_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported."
}
],
"variable": [
{
"key": "app_key_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/application_keys/:app_key_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported."
}
],
"variable": [
{
"key": "app_key_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/application_keys/:app_key_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported."
}
],
"variable": [
{
"key": "app_key_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}"
}
]
}
