Chilkat Online Tools

unicodeCpp / Datadog API Collection / Get a downtime

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

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

    CkHttpW http;
    bool success;

    CkJsonObjectW queryParams;
    queryParams.UpdateString(L"include",L"<string>");

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

    CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://api.app.ddog-gov.com/api/v2/downtime/:downtime_id",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete 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.

    const wchar_t *strVal = 0;
    const wchar_t *duration = 0;
    const wchar_t *rrule = 0;
    const wchar_t *start = 0;
    const wchar_t *Created_at = 0;
    const wchar_t *Disabled = 0;
    const wchar_t *v_Email = 0;
    const wchar_t *Handle = 0;
    const wchar_t *Icon = 0;
    const wchar_t *Modified_at = 0;
    const wchar_t *Name = 0;
    const wchar_t *Service_account = 0;
    const wchar_t *attributesStatus = 0;
    const wchar_t *Title = 0;
    const wchar_t *Verified = 0;
    const wchar_t *id = 0;
    const wchar_t *v_type = 0;
    int j;
    int count_j;

    const wchar_t *Canceled = jResp.stringOf(L"data.attributes.canceled");
    const wchar_t *Created = jResp.stringOf(L"data.attributes.created");
    const wchar_t *Display_timezone = jResp.stringOf(L"data.attributes.display_timezone");
    const wchar_t *Message = jResp.stringOf(L"data.attributes.message");
    const wchar_t *Modified = jResp.stringOf(L"data.attributes.modified");
    const wchar_t *Monitor_id = jResp.stringOf(L"data.attributes.monitor_identifier.monitor_id");
    const wchar_t *Mute_first_recovery_notification = jResp.stringOf(L"data.attributes.mute_first_recovery_notification");
    const wchar_t *v_End = jResp.stringOf(L"data.attributes.schedule.current_downtime.end");
    const wchar_t *Start = jResp.stringOf(L"data.attributes.schedule.current_downtime.start");
    const wchar_t *Timezone = jResp.stringOf(L"data.attributes.schedule.timezone");
    const wchar_t *Scope = jResp.stringOf(L"data.attributes.scope");
    const wchar_t *Status = jResp.stringOf(L"data.attributes.status");
    const wchar_t *Id = jResp.stringOf(L"data.id");
    const wchar_t *DataId = jResp.stringOf(L"data.relationships.created_by.data.id");
    const wchar_t *v_Type = jResp.stringOf(L"data.relationships.created_by.data.type");
    DataId = jResp.stringOf(L"data.relationships.monitor.data.id");
    const wchar_t *DataType = jResp.stringOf(L"data.relationships.monitor.data.type");
    const wchar_t *dataType = jResp.stringOf(L"data.type");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"data.attributes.notify_end_states");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf(L"data.attributes.notify_end_states[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"data.attributes.notify_end_types");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf(L"data.attributes.notify_end_types[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"data.attributes.schedule.recurrences");
    while (i < count_i) {
        jResp.put_I(i);
        duration = jResp.stringOf(L"data.attributes.schedule.recurrences[i].duration");
        rrule = jResp.stringOf(L"data.attributes.schedule.recurrences[i].rrule");
        start = jResp.stringOf(L"data.attributes.schedule.recurrences[i].start");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"included");
    while (i < count_i) {
        jResp.put_I(i);
        Created_at = jResp.stringOf(L"included[i].attributes.created_at");
        Disabled = jResp.stringOf(L"included[i].attributes.disabled");
        v_Email = jResp.stringOf(L"included[i].attributes.email");
        Handle = jResp.stringOf(L"included[i].attributes.handle");
        Icon = jResp.stringOf(L"included[i].attributes.icon");
        Modified_at = jResp.stringOf(L"included[i].attributes.modified_at");
        Name = jResp.stringOf(L"included[i].attributes.name");
        Service_account = jResp.stringOf(L"included[i].attributes.service_account");
        attributesStatus = jResp.stringOf(L"included[i].attributes.status");
        Title = jResp.stringOf(L"included[i].attributes.title");
        Verified = jResp.stringOf(L"included[i].attributes.verified");
        id = jResp.stringOf(L"included[i].id");
        DataId = jResp.stringOf(L"included[i].relationships.org.data.id");
        DataType = jResp.stringOf(L"included[i].relationships.org.data.type");
        v_type = jResp.stringOf(L"included[i].type");
        j = 0;
        count_j = jResp.SizeOfArray(L"included[i].relationships.other_orgs.data");
        while (j < count_j) {
            jResp.put_J(j);
            id = jResp.stringOf(L"included[i].relationships.other_orgs.data[j].id");
            v_type = jResp.stringOf(L"included[i].relationships.other_orgs.data[j].type");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"included[i].relationships.other_users.data");
        while (j < count_j) {
            jResp.put_J(j);
            id = jResp.stringOf(L"included[i].relationships.other_users.data[j].id");
            v_type = jResp.stringOf(L"included[i].relationships.other_users.data[j].type");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"included[i].relationships.roles.data");
        while (j < count_j) {
            jResp.put_J(j);
            id = jResp.stringOf(L"included[i].relationships.roles.data[j].id");
            v_type = jResp.stringOf(L"included[i].relationships.roles.data[j].type");
            j = j + 1;
        }

        i = i + 1;
    }
    }

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