Chilkat Online Tools

Swift / Core Services API / GetImage

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("Authorization", value: "{{signature}}")
    http.setRequestHeader("Date", value: "{{date}}")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId", 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)

    // {
    //   "compartmentId": "dolor commodo in",
    //   "id": "eu dolor Duis dolore irure",
    //   "lifecycleState": "AVAILABLE",
    //   "timeCreated": "1985-05-13T06:46:51.335Z",
    //   "operatingSystem": "deserunt cillum elit",
    //   "operatingSystemVersion": "sint et mollit do",
    //   "createImageAllowed": true,
    //   "agentFeatures": {
    //     "isManagementSupported": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isMonitoringSupported": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   },
    //   "baseImageId": "cillum exercitation voluptate non ullamco",
    //   "billableSizeInGBs": 16490567,
    //   "definedTags": {},
    //   "displayName": "qui laborum ad",
    //   "freeformTags": {},
    //   "launchMode": "PARAVIRTUALIZED",
    //   "launchOptions": {
    //     "bootVolumeType": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "firmware": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isConsistentVolumeNamingEnabled": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isPvEncryptionInTransitEnabled": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "networkType": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "remoteDataVolumeType": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   },
    //   "sizeInMBs": 57090852
    // }

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

    var compartmentId: String? = jResp.string(of: "compartmentId")
    var id: String? = jResp.string(of: "id")
    var lifecycleState: String? = jResp.string(of: "lifecycleState")
    var timeCreated: String? = jResp.string(of: "timeCreated")
    var operatingSystem: String? = jResp.string(of: "operatingSystem")
    var operatingSystemVersion: String? = jResp.string(of: "operatingSystemVersion")
    var createImageAllowed: Bool = jResp.bool(of: "createImageAllowed")
    var Value: String? = jResp.string(of: "agentFeatures.isManagementSupported.value")
    var IsMonitoringSupportedValue: String? = jResp.string(of: "agentFeatures.isMonitoringSupported.value")
    var baseImageId: String? = jResp.string(of: "baseImageId")
    var billableSizeInGBs: Int = jResp.int(of: "billableSizeInGBs").intValue
    var displayName: String? = jResp.string(of: "displayName")
    var launchMode: String? = jResp.string(of: "launchMode")
    var BootVolumeTypeValue: String? = jResp.string(of: "launchOptions.bootVolumeType.value")
    var FirmwareValue: String? = jResp.string(of: "launchOptions.firmware.value")
    var IsConsistentVolumeNamingEnabledValue: String? = jResp.string(of: "launchOptions.isConsistentVolumeNamingEnabled.value")
    var IsPvEncryptionInTransitEnabledValue: String? = jResp.string(of: "launchOptions.isPvEncryptionInTransitEnabled.value")
    var NetworkTypeValue: String? = jResp.string(of: "launchOptions.networkType.value")
    var RemoteDataVolumeTypeValue: String? = jResp.string(of: "launchOptions.remoteDataVolumeType.value")
    var sizeInMBs: Int = jResp.int(of: "sizeInMBs").intValue

}

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId

Postman Collection Item JSON

{
  "name": "GetImage",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/images/:imageId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "images",
        ":imageId"
      ],
      "variable": [
        {
          "key": "imageId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
        }
      ]
    },
    "description": "Gets the specified image."
  },
  "response": [
    {
      "name": "The image was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"compartmentId\": \"dolor commodo in\",\n \"id\": \"eu dolor Duis dolore irure\",\n \"lifecycleState\": \"AVAILABLE\",\n \"timeCreated\": \"1985-05-13T06:46:51.335Z\",\n \"operatingSystem\": \"deserunt cillum elit\",\n \"operatingSystemVersion\": \"sint et mollit do\",\n \"createImageAllowed\": true,\n \"agentFeatures\": {\n  \"isManagementSupported\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isMonitoringSupported\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"baseImageId\": \"cillum exercitation voluptate non ullamco\",\n \"billableSizeInGBs\": 16490567,\n \"definedTags\": {},\n \"displayName\": \"qui laborum ad\",\n \"freeformTags\": {},\n \"launchMode\": \"PARAVIRTUALIZED\",\n \"launchOptions\": {\n  \"bootVolumeType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"firmware\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isConsistentVolumeNamingEnabled\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isPvEncryptionInTransitEnabled\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"remoteDataVolumeType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"sizeInMBs\": 57090852\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}