Chilkat Online Tools

DataFlex / Core Services API / GetImage

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sCompartmentId
    String sId
    String sLifecycleState
    String sTimeCreated
    String sOperatingSystem
    String sOperatingSystemVersion
    Boolean iCreateImageAllowed
    String sValue
    String sIsMonitoringSupportedValue
    String sBaseImageId
    Integer iBillableSizeInGBs
    String sDisplayName
    String sLaunchMode
    String sBootVolumeTypeValue
    String sFirmwareValue
    String sIsConsistentVolumeNamingEnabledValue
    String sIsPvEncryptionInTransitEnabledValue
    String sNetworkTypeValue
    String sRemoteDataVolumeTypeValue
    Integer iSizeInMBs
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
    Send ComSetRequestHeader To hoHttp "Date" "{{date}}"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

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

    Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
    Get ComStringOf Of hoJResp "id" To sId
    Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
    Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
    Get ComStringOf Of hoJResp "operatingSystem" To sOperatingSystem
    Get ComStringOf Of hoJResp "operatingSystemVersion" To sOperatingSystemVersion
    Get ComBoolOf Of hoJResp "createImageAllowed" To iCreateImageAllowed
    Get ComStringOf Of hoJResp "agentFeatures.isManagementSupported.value" To sValue
    Get ComStringOf Of hoJResp "agentFeatures.isMonitoringSupported.value" To sIsMonitoringSupportedValue
    Get ComStringOf Of hoJResp "baseImageId" To sBaseImageId
    Get ComIntOf Of hoJResp "billableSizeInGBs" To iBillableSizeInGBs
    Get ComStringOf Of hoJResp "displayName" To sDisplayName
    Get ComStringOf Of hoJResp "launchMode" To sLaunchMode
    Get ComStringOf Of hoJResp "launchOptions.bootVolumeType.value" To sBootVolumeTypeValue
    Get ComStringOf Of hoJResp "launchOptions.firmware.value" To sFirmwareValue
    Get ComStringOf Of hoJResp "launchOptions.isConsistentVolumeNamingEnabled.value" To sIsConsistentVolumeNamingEnabledValue
    Get ComStringOf Of hoJResp "launchOptions.isPvEncryptionInTransitEnabled.value" To sIsPvEncryptionInTransitEnabledValue
    Get ComStringOf Of hoJResp "launchOptions.networkType.value" To sNetworkTypeValue
    Get ComStringOf Of hoJResp "launchOptions.remoteDataVolumeType.value" To sRemoteDataVolumeTypeValue
    Get ComIntOf Of hoJResp "sizeInMBs" To iSizeInMBs


End_Procedure

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