Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *strVal;
const wchar_t *duration;
const wchar_t *rrule;
const wchar_t *start;
const wchar_t *Created_at;
const wchar_t *Disabled;
const wchar_t *v_Email;
const wchar_t *Handle;
const wchar_t *Icon;
const wchar_t *Modified_at;
const wchar_t *Name;
const wchar_t *Service_account;
const wchar_t *attributesStatus;
const wchar_t *Title;
const wchar_t *Verified;
const wchar_t *id;
const wchar_t *v_type;
int j;
int count_j;
const wchar_t *Canceled;
const wchar_t *Created;
const wchar_t *Display_timezone;
const wchar_t *Message;
const wchar_t *Modified;
const wchar_t *Monitor_id;
const wchar_t *Mute_first_recovery_notification;
const wchar_t *v_End;
const wchar_t *Start;
const wchar_t *Timezone;
const wchar_t *Scope;
const wchar_t *Status;
const wchar_t *Id;
const wchar_t *DataId;
const wchar_t *v_Type;
const wchar_t *DataType;
const wchar_t *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 = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"include",L"<string>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.app.ddog-gov.com/api/v2/downtime/:downtime_id",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "canceled": "<dateTime>",
// "created": "<dateTime>",
// "display_timezone": "UTC",
// "message": "<string>",
// "modified": "<dateTime>",
// "monitor_identifier": {
// "monitor_id": "<long>"
// },
// "mute_first_recovery_notification": "<boolean>",
// "notify_end_states": [
// "alert",
// "alert"
// ],
// "notify_end_types": [
// "canceled",
// "expired"
// ],
// "schedule": {
// "recurrences": [
// {
// "duration": "<string>",
// "rrule": "<string>",
// "start": "<string>"
// }
// ],
// "current_downtime": {
// "end": "<dateTime>",
// "start": "<dateTime>"
// },
// "timezone": "UTC"
// },
// "scope": "<string>",
// "status": "scheduled"
// },
// "id": "<string>",
// "relationships": {
// "created_by": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// },
// "monitor": {
// "data": {
// "id": "<string>",
// "type": "monitors"
// }
// }
// },
// "type": "downtime"
// },
// "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.
Canceled = CkJsonObjectW_stringOf(jResp,L"data.attributes.canceled");
Created = CkJsonObjectW_stringOf(jResp,L"data.attributes.created");
Display_timezone = CkJsonObjectW_stringOf(jResp,L"data.attributes.display_timezone");
Message = CkJsonObjectW_stringOf(jResp,L"data.attributes.message");
Modified = CkJsonObjectW_stringOf(jResp,L"data.attributes.modified");
Monitor_id = CkJsonObjectW_stringOf(jResp,L"data.attributes.monitor_identifier.monitor_id");
Mute_first_recovery_notification = CkJsonObjectW_stringOf(jResp,L"data.attributes.mute_first_recovery_notification");
v_End = CkJsonObjectW_stringOf(jResp,L"data.attributes.schedule.current_downtime.end");
Start = CkJsonObjectW_stringOf(jResp,L"data.attributes.schedule.current_downtime.start");
Timezone = CkJsonObjectW_stringOf(jResp,L"data.attributes.schedule.timezone");
Scope = CkJsonObjectW_stringOf(jResp,L"data.attributes.scope");
Status = CkJsonObjectW_stringOf(jResp,L"data.attributes.status");
Id = CkJsonObjectW_stringOf(jResp,L"data.id");
DataId = CkJsonObjectW_stringOf(jResp,L"data.relationships.created_by.data.id");
v_Type = CkJsonObjectW_stringOf(jResp,L"data.relationships.created_by.data.type");
DataId = CkJsonObjectW_stringOf(jResp,L"data.relationships.monitor.data.id");
DataType = CkJsonObjectW_stringOf(jResp,L"data.relationships.monitor.data.type");
dataType = CkJsonObjectW_stringOf(jResp,L"data.type");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.attributes.notify_end_states");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"data.attributes.notify_end_states[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.attributes.notify_end_types");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"data.attributes.notify_end_types[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.attributes.schedule.recurrences");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
duration = CkJsonObjectW_stringOf(jResp,L"data.attributes.schedule.recurrences[i].duration");
rrule = CkJsonObjectW_stringOf(jResp,L"data.attributes.schedule.recurrences[i].rrule");
start = CkJsonObjectW_stringOf(jResp,L"data.attributes.schedule.recurrences[i].start");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"included");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
Created_at = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.created_at");
Disabled = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.disabled");
v_Email = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.email");
Handle = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.handle");
Icon = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.icon");
Modified_at = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.modified_at");
Name = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.name");
Service_account = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.service_account");
attributesStatus = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.status");
Title = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.title");
Verified = CkJsonObjectW_stringOf(jResp,L"included[i].attributes.verified");
id = CkJsonObjectW_stringOf(jResp,L"included[i].id");
DataId = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.org.data.id");
DataType = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.org.data.type");
v_type = CkJsonObjectW_stringOf(jResp,L"included[i].type");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"included[i].relationships.other_orgs.data");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
id = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.other_orgs.data[j].id");
v_type = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.other_orgs.data[j].type");
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"included[i].relationships.other_users.data");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
id = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.other_users.data[j].id");
v_type = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.other_users.data[j].type");
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"included[i].relationships.roles.data");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
id = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.roles.data[j].id");
v_type = CkJsonObjectW_stringOf(jResp,L"included[i].relationships.roles.data[j].type");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "include=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/downtime/:downtime_id
Postman Collection Item JSON
{
"name": "Get a downtime",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
}
],
"variable": [
{
"key": "downtime_id",
"value": "<string>"
}
]
},
"description": "Get downtime detail by `downtime_id`."
},
"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/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"canceled\": \"<dateTime>\",\n \"created\": \"<dateTime>\",\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"modified\": \"<dateTime>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"alert\",\n \"alert\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"<dateTime>\",\n \"start\": \"<dateTime>\"\n },\n \"timezone\": \"UTC\"\n },\n \"scope\": \"<string>\",\n \"status\": \"scheduled\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\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/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
}
],
"variable": [
{
"key": "downtime_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/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
}
],
"variable": [
{
"key": "downtime_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/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
}
],
"variable": [
{
"key": "downtime_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/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
}
],
"variable": [
{
"key": "downtime_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}"
}
]
}
