Chilkat Online Tools

PureBasic / Core Services API / GetComputeImageCapabilitySchema

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"isMergeEnabled","false")

    CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
    CkHttp::ckSetRequestHeader(http,"Date","{{date}}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://iaas.{{region}}.oraclecloud.com/20160918/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    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 = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "id": "ex",
    ;   "displayName": "ut nisi",
    ;   "imageId": "ea dolore tempor et",
    ;   "computeGlobalImageCapabilitySchemaId": "tempor in",
    ;   "computeGlobalImageCapabilitySchemaVersionName": "nulla",
    ;   "schemaData": {},
    ;   "timeCreated": "1959-07-11T11:44:54.400Z",
    ;   "compartmentId": "veniam",
    ;   "definedTags": {},
    ;   "freeformTags": {}
    ; }

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

    id.s = CkJsonObject::ckStringOf(jResp,"id")
    displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
    imageId.s = CkJsonObject::ckStringOf(jResp,"imageId")
    computeGlobalImageCapabilitySchemaId.s = CkJsonObject::ckStringOf(jResp,"computeGlobalImageCapabilitySchemaId")
    computeGlobalImageCapabilitySchemaVersionName.s = CkJsonObject::ckStringOf(jResp,"computeGlobalImageCapabilitySchemaVersionName")
    timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
    compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "isMergeEnabled=false"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId

Postman Collection Item JSON

{
  "name": "GetComputeImageCapabilitySchema",
  "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}}/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId?isMergeEnabled=false",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "computeImageCapabilitySchemas",
        ":computeImageCapabilitySchemaId"
      ],
      "query": [
        {
          "key": "isMergeEnabled",
          "value": "false",
          "description": "Merge the image capability schema with the global image capability schema\n"
        }
      ],
      "variable": [
        {
          "key": "computeImageCapabilitySchemaId",
          "value": "amet ut",
          "description": "(Required) The id of the compute image capability schema or the image ocid"
        }
      ]
    },
    "description": "Gets the specified Compute Image Capability Schema\n"
  },
  "response": [
    {
      "name": "The compute image capability schema retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId?isMergeEnabled=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeImageCapabilitySchemas",
            ":computeImageCapabilitySchemaId"
          ],
          "query": [
            {
              "key": "isMergeEnabled",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "computeImageCapabilitySchemaId"
            }
          ]
        }
      },
      "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 \"id\": \"ex\",\n \"displayName\": \"ut nisi\",\n \"imageId\": \"ea dolore tempor et\",\n \"computeGlobalImageCapabilitySchemaId\": \"tempor in\",\n \"computeGlobalImageCapabilitySchemaVersionName\": \"nulla\",\n \"schemaData\": {},\n \"timeCreated\": \"1959-07-11T11:44:54.400Z\",\n \"compartmentId\": \"veniam\",\n \"definedTags\": {},\n \"freeformTags\": {}\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId?isMergeEnabled=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeImageCapabilitySchemas",
            ":computeImageCapabilitySchemaId"
          ],
          "query": [
            {
              "key": "isMergeEnabled",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "computeImageCapabilitySchemaId"
            }
          ]
        }
      },
      "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}}/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId?isMergeEnabled=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeImageCapabilitySchemas",
            ":computeImageCapabilitySchemaId"
          ],
          "query": [
            {
              "key": "isMergeEnabled",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "computeImageCapabilitySchemaId"
            }
          ]
        }
      },
      "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": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId?isMergeEnabled=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeImageCapabilitySchemas",
            ":computeImageCapabilitySchemaId"
          ],
          "query": [
            {
              "key": "isMergeEnabled",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "computeImageCapabilitySchemaId"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_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}}/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId?isMergeEnabled=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeImageCapabilitySchemas",
            ":computeImageCapabilitySchemaId"
          ],
          "query": [
            {
              "key": "isMergeEnabled",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "computeImageCapabilitySchemaId"
            }
          ]
        }
      },
      "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}}/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId?isMergeEnabled=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeImageCapabilitySchemas",
            ":computeImageCapabilitySchemaId"
          ],
          "query": [
            {
              "key": "isMergeEnabled",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "computeImageCapabilitySchemaId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}