Chilkat Online Tools

PureBasic / Datadog API Collection / Get Corrections For an SLO

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/v1/slo/:slo_id/corrections",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": {
    ;         "category": "Scheduled Maintenance",
    ;         "created_at": -74919575,
    ;         "creator": {
    ;           "email": "ex veniam",
    ;           "handle": "velit",
    ;           "name": "voluptate in sit veniam Lorem"
    ;         },
    ;         "description": "veniam laboris",
    ;         "duration": 3600,
    ;         "end": -8908818,
    ;         "modified_at": 5115488,
    ;         "modifier": {
    ;           "email": "sit consequat",
    ;           "handle": "magna irure consequat",
    ;           "name": "labore aliquip consequat fugiat"
    ;         },
    ;         "rrule": "FREQ=DAILY;INTERVAL=10;COUNT=5",
    ;         "slo_id": "labore commodo",
    ;         "start": 6104289,
    ;         "timezone": "consectetur fugiat elit laborum deserunt"
    ;       },
    ;       "id": "anim",
    ;       "type": "correction"
    ;     },
    ;     {
    ;       "attributes": {
    ;         "category": "Scheduled Maintenance",
    ;         "created_at": -50145390,
    ;         "creator": {
    ;           "email": "aliquip amet",
    ;           "handle": "amet ex",
    ;           "name": "sed non proident"
    ;         },
    ;         "description": "laborum reprehenderit",
    ;         "duration": 3600,
    ;         "end": -50463285,
    ;         "modified_at": -64168623,
    ;         "modifier": {
    ;           "email": "in minim s",
    ;           "handle": "id aliqua",
    ;           "name": "officia do fugiat"
    ;         },
    ;         "rrule": "FREQ=DAILY;INTERVAL=10;COUNT=5",
    ;         "slo_id": "sit nost",
    ;         "start": 47690351,
    ;         "timezone": "consequat ipsum quis ut"
    ;       },
    ;       "id": "incididunt eiusmod id",
    ;       "type": "correction"
    ;     }
    ;   ],
    ;   "meta": {
    ;     "page": {
    ;       "total_count": -1541220,
    ;       "total_filtered_count": -20550176
    ;     }
    ;   }
    ; }

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

    Category.s
    Created_at.i
    v_Email.s
    Handle.s
    Name.s
    Description.s
    Duration.i
    v_End.i
    Modified_at.i
    ModifierEmail.s
    ModifierHandle.s
    ModifierName.s
    Rrule.s
    Slo_id.s
    Start.i
    Timezone.s
    id.s
    v_type.s

    Total_count.i = CkJsonObject::ckIntOf(jResp,"meta.page.total_count")
    Total_filtered_count.i = CkJsonObject::ckIntOf(jResp,"meta.page.total_filtered_count")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Category = CkJsonObject::ckStringOf(jResp,"data[i].attributes.category")
        Created_at = CkJsonObject::ckIntOf(jResp,"data[i].attributes.created_at")
        v_Email = CkJsonObject::ckStringOf(jResp,"data[i].attributes.creator.email")
        Handle = CkJsonObject::ckStringOf(jResp,"data[i].attributes.creator.handle")
        Name = CkJsonObject::ckStringOf(jResp,"data[i].attributes.creator.name")
        Description = CkJsonObject::ckStringOf(jResp,"data[i].attributes.description")
        Duration = CkJsonObject::ckIntOf(jResp,"data[i].attributes.duration")
        v_End = CkJsonObject::ckIntOf(jResp,"data[i].attributes.end")
        Modified_at = CkJsonObject::ckIntOf(jResp,"data[i].attributes.modified_at")
        ModifierEmail = CkJsonObject::ckStringOf(jResp,"data[i].attributes.modifier.email")
        ModifierHandle = CkJsonObject::ckStringOf(jResp,"data[i].attributes.modifier.handle")
        ModifierName = CkJsonObject::ckStringOf(jResp,"data[i].attributes.modifier.name")
        Rrule = CkJsonObject::ckStringOf(jResp,"data[i].attributes.rrule")
        Slo_id = CkJsonObject::ckStringOf(jResp,"data[i].attributes.slo_id")
        Start = CkJsonObject::ckIntOf(jResp,"data[i].attributes.start")
        Timezone = CkJsonObject::ckStringOf(jResp,"data[i].attributes.timezone")
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
        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/v1/slo/:slo_id/corrections

Postman Collection Item JSON

{
  "name": "Get Corrections For an SLO",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/slo/:slo_id/corrections",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "slo",
        ":slo_id",
        "corrections"
      ],
      "variable": [
        {
          "key": "slo_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get corrections applied to an SLO"
  },
  "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/slo/:slo_id/corrections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id",
            "corrections"
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"category\": \"Scheduled Maintenance\",\n        \"created_at\": -74919575,\n        \"creator\": {\n          \"email\": \"ex veniam\",\n          \"handle\": \"velit\",\n          \"name\": \"voluptate in sit veniam Lorem\"\n        },\n        \"description\": \"veniam laboris\",\n        \"duration\": 3600,\n        \"end\": -8908818,\n        \"modified_at\": 5115488,\n        \"modifier\": {\n          \"email\": \"sit consequat\",\n          \"handle\": \"magna irure consequat\",\n          \"name\": \"labore aliquip consequat fugiat\"\n        },\n        \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n        \"slo_id\": \"labore commodo\",\n        \"start\": 6104289,\n        \"timezone\": \"consectetur fugiat elit laborum deserunt\"\n      },\n      \"id\": \"anim\",\n      \"type\": \"correction\"\n    },\n    {\n      \"attributes\": {\n        \"category\": \"Scheduled Maintenance\",\n        \"created_at\": -50145390,\n        \"creator\": {\n          \"email\": \"aliquip amet\",\n          \"handle\": \"amet ex\",\n          \"name\": \"sed non proident\"\n        },\n        \"description\": \"laborum reprehenderit\",\n        \"duration\": 3600,\n        \"end\": -50463285,\n        \"modified_at\": -64168623,\n        \"modifier\": {\n          \"email\": \"in minim s\",\n          \"handle\": \"id aliqua\",\n          \"name\": \"officia do fugiat\"\n        },\n        \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n        \"slo_id\": \"sit nost\",\n        \"start\": 47690351,\n        \"timezone\": \"consequat ipsum quis ut\"\n      },\n      \"id\": \"incididunt eiusmod id\",\n      \"type\": \"correction\"\n    }\n  ],\n  \"meta\": {\n    \"page\": {\n      \"total_count\": -1541220,\n      \"total_filtered_count\": -20550176\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/v1/slo/:slo_id/corrections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id",
            "corrections"
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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/slo/:slo_id/corrections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id",
            "corrections"
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "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": "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/v1/slo/:slo_id/corrections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id",
            "corrections"
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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/slo/:slo_id/corrections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id",
            "corrections"
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}