Chilkat Online Tools

unicodeC / Datadog API Collection / Get all global variables

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *description;
    const wchar_t *name;
    BOOL Secure;
    const wchar_t *Value;
    const wchar_t *id;
    const wchar_t *v_Type;
    const wchar_t *Field;
    const wchar_t *LocalVariableName;
    const wchar_t *ParserType;
    const wchar_t *ParserValue;
    const wchar_t *parse_test_public_id;
    int j;
    int count_j;
    const wchar_t *strVal;
    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();

    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://api.app.ddog-gov.com/api/v1/synthetics/variables",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

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

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

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

    // {
    //   "variables": [
    //     {
    //       "description": "Example description",
    //       "name": "MY_VARIABLE",
    //       "tags": [
    //         "team:front",
    //         "test:workflow-1"
    //       ],
    //       "value": {
    //         "secure": true,
    //         "value": "value"
    //       },
    //       "attributes": {
    //         "restricted_roles": [
    //           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    //         ]
    //       },
    //       "id": "id Ut Excepteur commodo consectetur",
    //       "parse_test_options": {
    //         "type": "http_body",
    //         "field": "content-type",
    //         "localVariableName": "LOCAL_VARIABLE",
    //         "parser": {
    //           "type": "regex",
    //           "value": ".*"
    //         }
    //       },
    //       "parse_test_public_id": "abc-def-123"
    //     },
    //     {
    //       "description": "Example description",
    //       "name": "MY_VARIABLE",
    //       "tags": [
    //         "team:front",
    //         "test:workflow-1"
    //       ],
    //       "value": {
    //         "secure": true,
    //         "value": "value"
    //       },
    //       "attributes": {
    //         "restricted_roles": [
    //           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    //         ]
    //       },
    //       "id": "consectetur enim magna",
    //       "parse_test_options": {
    //         "type": "http_body",
    //         "field": "content-type",
    //         "localVariableName": "LOCAL_VARIABLE",
    //         "parser": {
    //           "type": "regex",
    //           "value": ".*"
    //         }
    //       },
    //       "parse_test_public_id": "abc-def-123"
    //     }
    //   ]
    // }

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

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"variables");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        description = CkJsonObjectW_stringOf(jResp,L"variables[i].description");
        name = CkJsonObjectW_stringOf(jResp,L"variables[i].name");
        Secure = CkJsonObjectW_BoolOf(jResp,L"variables[i].value.secure");
        Value = CkJsonObjectW_stringOf(jResp,L"variables[i].value.value");
        id = CkJsonObjectW_stringOf(jResp,L"variables[i].id");
        v_Type = CkJsonObjectW_stringOf(jResp,L"variables[i].parse_test_options.type");
        Field = CkJsonObjectW_stringOf(jResp,L"variables[i].parse_test_options.field");
        LocalVariableName = CkJsonObjectW_stringOf(jResp,L"variables[i].parse_test_options.localVariableName");
        ParserType = CkJsonObjectW_stringOf(jResp,L"variables[i].parse_test_options.parser.type");
        ParserValue = CkJsonObjectW_stringOf(jResp,L"variables[i].parse_test_options.parser.value");
        parse_test_public_id = CkJsonObjectW_stringOf(jResp,L"variables[i].parse_test_public_id");
        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"variables[i].tags");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            strVal = CkJsonObjectW_stringOf(jResp,L"variables[i].tags[j]");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"variables[i].attributes.restricted_roles");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            strVal = CkJsonObjectW_stringOf(jResp,L"variables[i].attributes.restricted_roles[j]");
            j = j + 1;
        }

        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/variables

Postman Collection Item JSON

{
  "name": "Get all global variables",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/variables",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "variables"
      ]
    },
    "description": "Get the list of all Synthetic global variables."
  },
  "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/v1/synthetics/variables",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"variables\": [\n    {\n      \"description\": \"Example description\",\n      \"name\": \"MY_VARIABLE\",\n      \"tags\": [\n        \"team:front\",\n        \"test:workflow-1\"\n      ],\n      \"value\": {\n        \"secure\": true,\n        \"value\": \"value\"\n      },\n      \"attributes\": {\n        \"restricted_roles\": [\n          \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n        ]\n      },\n      \"id\": \"id Ut Excepteur commodo consectetur\",\n      \"parse_test_options\": {\n        \"type\": \"http_body\",\n        \"field\": \"content-type\",\n        \"localVariableName\": \"LOCAL_VARIABLE\",\n        \"parser\": {\n          \"type\": \"regex\",\n          \"value\": \".*\"\n        }\n      },\n      \"parse_test_public_id\": \"abc-def-123\"\n    },\n    {\n      \"description\": \"Example description\",\n      \"name\": \"MY_VARIABLE\",\n      \"tags\": [\n        \"team:front\",\n        \"test:workflow-1\"\n      ],\n      \"value\": {\n        \"secure\": true,\n        \"value\": \"value\"\n      },\n      \"attributes\": {\n        \"restricted_roles\": [\n          \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n        ]\n      },\n      \"id\": \"consectetur enim magna\",\n      \"parse_test_options\": {\n        \"type\": \"http_body\",\n        \"field\": \"content-type\",\n        \"localVariableName\": \"LOCAL_VARIABLE\",\n        \"parser\": {\n          \"type\": \"regex\",\n          \"value\": \".*\"\n        }\n      },\n      \"parse_test_public_id\": \"abc-def-123\"\n    }\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/v1/synthetics/variables",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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/v1/synthetics/variables",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}