Chilkat Online Tools

PowerBuilder / Core Services API / GetImage

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_CompartmentId
string ls_Id
string ls_LifecycleState
string ls_TimeCreated
string ls_OperatingSystem
string ls_OperatingSystemVersion
integer li_CreateImageAllowed
string ls_Value
string ls_IsMonitoringSupportedValue
string ls_BaseImageId
integer li_BillableSizeInGBs
string ls_DisplayName
string ls_LaunchMode
string ls_BootVolumeTypeValue
string ls_FirmwareValue
string ls_IsConsistentVolumeNamingEnabledValue
string ls_IsPvEncryptionInTransitEnabledValue
string ls_NetworkTypeValue
string ls_RemoteDataVolumeTypeValue
integer li_SizeInMBs

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("Authorization","{{signature}}")
loo_Http.SetRequestHeader("Date","{{date}}")

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

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

ls_CompartmentId = loo_JResp.StringOf("compartmentId")
ls_Id = loo_JResp.StringOf("id")
ls_LifecycleState = loo_JResp.StringOf("lifecycleState")
ls_TimeCreated = loo_JResp.StringOf("timeCreated")
ls_OperatingSystem = loo_JResp.StringOf("operatingSystem")
ls_OperatingSystemVersion = loo_JResp.StringOf("operatingSystemVersion")
li_CreateImageAllowed = loo_JResp.BoolOf("createImageAllowed")
ls_Value = loo_JResp.StringOf("agentFeatures.isManagementSupported.value")
ls_IsMonitoringSupportedValue = loo_JResp.StringOf("agentFeatures.isMonitoringSupported.value")
ls_BaseImageId = loo_JResp.StringOf("baseImageId")
li_BillableSizeInGBs = loo_JResp.IntOf("billableSizeInGBs")
ls_DisplayName = loo_JResp.StringOf("displayName")
ls_LaunchMode = loo_JResp.StringOf("launchMode")
ls_BootVolumeTypeValue = loo_JResp.StringOf("launchOptions.bootVolumeType.value")
ls_FirmwareValue = loo_JResp.StringOf("launchOptions.firmware.value")
ls_IsConsistentVolumeNamingEnabledValue = loo_JResp.StringOf("launchOptions.isConsistentVolumeNamingEnabled.value")
ls_IsPvEncryptionInTransitEnabledValue = loo_JResp.StringOf("launchOptions.isPvEncryptionInTransitEnabled.value")
ls_NetworkTypeValue = loo_JResp.StringOf("launchOptions.networkType.value")
ls_RemoteDataVolumeTypeValue = loo_JResp.StringOf("launchOptions.remoteDataVolumeType.value")
li_SizeInMBs = loo_JResp.IntOf("sizeInMBs")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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