Chilkat Online Tools

Swift3 / Datadog API Collection / Get details of batch

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.setRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/ci/batch/:batch_id", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

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

    // {
    //   "data": {
    //     "metadata": {
    //       "ci": {
    //         "pipeline": {
    //           "url": "dolor irure amet aliqua"
    //         },
    //         "provider": {
    //           "name": "velit voluptate minim tempor et"
    //         }
    //       },
    //       "git": {
    //         "branch": "proident pariatur cillum ipsum",
    //         "commitSha": "no"
    //       }
    //     },
    //     "results": [
    //       {
    //         "device": "laptop_large",
    //         "duration": 77555392.34670219,
    //         "execution_rule": "blocking",
    //         "location": "nostrud consectetur proident elit",
    //         "result_id": "ad in",
    //         "retries": 27165346.602910966,
    //         "status": "passed",
    //         "test_name": "in Excepteur",
    //         "test_public_id": "aute sint",
    //         "test_type": "browser"
    //       },
    //       {
    //         "device": "laptop_large",
    //         "duration": -71572766.6529502,
    //         "execution_rule": "non_blocking",
    //         "location": "velit ullamco",
    //         "result_id": "quis irure officia Lorem enim",
    //         "retries": 66253781.442619294,
    //         "status": "passed",
    //         "test_name": "reprehenderit voluptate incididu",
    //         "test_public_id": "ipsum Duis",
    //         "test_type": "api"
    //       }
    //     ],
    //     "status": "passed"
    //   }
    // }

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

    var device: String?
    var duration: String?
    var execution_rule: String?
    var location: String?
    var result_id: String?
    var retries: String?
    var status: String?
    var test_name: String?
    var test_public_id: String?
    var test_type: String?

    var v_Url: String? = jResp.string(of: "data.metadata.ci.pipeline.url")
    var Name: String? = jResp.string(of: "data.metadata.ci.provider.name")
    var Branch: String? = jResp.string(of: "data.metadata.git.branch")
    var CommitSha: String? = jResp.string(of: "data.metadata.git.commitSha")
    var Status: String? = jResp.string(of: "data.status")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data.results").intValue
    while i < count_i {
        jResp.i = i
        device = jResp.string(of: "data.results[i].device")
        duration = jResp.string(of: "data.results[i].duration")
        execution_rule = jResp.string(of: "data.results[i].execution_rule")
        location = jResp.string(of: "data.results[i].location")
        result_id = jResp.string(of: "data.results[i].result_id")
        retries = jResp.string(of: "data.results[i].retries")
        status = jResp.string(of: "data.results[i].status")
        test_name = jResp.string(of: "data.results[i].test_name")
        test_public_id = jResp.string(of: "data.results[i].test_public_id")
        test_type = jResp.string(of: "data.results[i].test_type")
        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get details of batch",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/ci/batch/:batch_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "ci",
        "batch",
        ":batch_id"
      ],
      "variable": [
        {
          "key": "batch_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get a batch's updated details."
  },
  "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/ci/batch/:batch_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "ci",
            "batch",
            ":batch_id"
          ],
          "variable": [
            {
              "key": "batch_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"metadata\": {\n      \"ci\": {\n        \"pipeline\": {\n          \"url\": \"dolor irure amet aliqua\"\n        },\n        \"provider\": {\n          \"name\": \"velit voluptate minim tempor et\"\n        }\n      },\n      \"git\": {\n        \"branch\": \"proident pariatur cillum ipsum\",\n        \"commitSha\": \"no\"\n      }\n    },\n    \"results\": [\n      {\n        \"device\": \"laptop_large\",\n        \"duration\": 77555392.34670219,\n        \"execution_rule\": \"blocking\",\n        \"location\": \"nostrud consectetur proident elit\",\n        \"result_id\": \"ad in\",\n        \"retries\": 27165346.602910966,\n        \"status\": \"passed\",\n        \"test_name\": \"in Excepteur\",\n        \"test_public_id\": \"aute sint\",\n        \"test_type\": \"browser\"\n      },\n      {\n        \"device\": \"laptop_large\",\n        \"duration\": -71572766.6529502,\n        \"execution_rule\": \"non_blocking\",\n        \"location\": \"velit ullamco\",\n        \"result_id\": \"quis irure officia Lorem enim\",\n        \"retries\": 66253781.442619294,\n        \"status\": \"passed\",\n        \"test_name\": \"reprehenderit voluptate incididu\",\n        \"test_public_id\": \"ipsum Duis\",\n        \"test_type\": \"api\"\n      }\n    ],\n    \"status\": \"passed\"\n  }\n}"
    },
    {
      "name": "Batch does not exist.",
      "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/ci/batch/:batch_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "ci",
            "batch",
            ":batch_id"
          ],
          "variable": [
            {
              "key": "batch_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/synthetics/ci/batch/:batch_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "ci",
            "batch",
            ":batch_id"
          ],
          "variable": [
            {
              "key": "batch_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}"
    }
  ]
}