Chilkat Online Tools

PureBasic / Core Services API / AddImageShapeCompatibilityEntry

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

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "memoryConstraints": {
    ;     "maxInGBs": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "minInGBs": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   },
    ;   "ocpuConstraints": {
    ;     "max": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "min": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   }
    ; }

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

    CkJsonObject::ckUpdateString(json,"memoryConstraints.maxInGBs.value","<Error: Too many levels of nesting to fake this schema>")
    CkJsonObject::ckUpdateString(json,"memoryConstraints.minInGBs.value","<Error: Too many levels of nesting to fake this schema>")
    CkJsonObject::ckUpdateString(json,"ocpuConstraints.max.value","<Error: Too many levels of nesting to fake this schema>")
    CkJsonObject::ckUpdateString(json,"ocpuConstraints.min.value","<Error: Too many levels of nesting to fake this schema>")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
    CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
    CkHttp::ckSetRequestHeader(http,"Date","{{date}}")

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId/shapes/:shapeName",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        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(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "imageId": "Duis ex elit",
    ;   "shape": "nulla mollit",
    ;   "memoryConstraints": {
    ;     "maxInGBs": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "minInGBs": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   },
    ;   "ocpuConstraints": {
    ;     "max": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "min": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   }
    ; }

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

    imageId.s = CkJsonObject::ckStringOf(jResp,"imageId")
    shape.s = CkJsonObject::ckStringOf(jResp,"shape")
    Value.s = CkJsonObject::ckStringOf(jResp,"memoryConstraints.maxInGBs.value")
    MinInGBsValue.s = CkJsonObject::ckStringOf(jResp,"memoryConstraints.minInGBs.value")
    MaxValue.s = CkJsonObject::ckStringOf(jResp,"ocpuConstraints.max.value")
    MinValue.s = CkJsonObject::ckStringOf(jResp,"ocpuConstraints.min.value")


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "memoryConstraints": {
        "maxInGBs": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "minInGBs": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
        }
    },
    "ocpuConstraints": {
        "max": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "min": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
        }
    }
}'
https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId/shapes/:shapeName

Postman Collection Item JSON

{
  "name": "AddImageShapeCompatibilityEntry",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"memoryConstraints\": {\n        \"maxInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"minInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    },\n    \"ocpuConstraints\": {\n        \"max\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"min\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "images",
        ":imageId",
        "shapes",
        ":shapeName"
      ],
      "variable": [
        {
          "key": "imageId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
        },
        {
          "key": "shapeName",
          "value": "amet ut",
          "description": "(Required) Shape name."
        }
      ]
    },
    "description": "Adds a shape to the compatible shapes list for the image."
  },
  "response": [
    {
      "name": "The shape has been added to the compatible shapes list.",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"memoryConstraints\": {\n        \"maxInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"minInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    },\n    \"ocpuConstraints\": {\n        \"max\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"min\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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 \"imageId\": \"Duis ex elit\",\n \"shape\": \"nulla mollit\",\n \"memoryConstraints\": {\n  \"maxInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"minInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"ocpuConstraints\": {\n  \"max\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"min\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"memoryConstraints\": {\n        \"maxInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"minInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    },\n    \"ocpuConstraints\": {\n        \"max\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"min\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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": "Unauthorized",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"memoryConstraints\": {\n        \"maxInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"minInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    },\n    \"ocpuConstraints\": {\n        \"max\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"min\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"memoryConstraints\": {\n        \"maxInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"minInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    },\n    \"ocpuConstraints\": {\n        \"max\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"min\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"memoryConstraints\": {\n        \"maxInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"minInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    },\n    \"ocpuConstraints\": {\n        \"max\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"min\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"memoryConstraints\": {\n        \"maxInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"minInGBs\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    },\n    \"ocpuConstraints\": {\n        \"max\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        },\n        \"min\": {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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}"
    }
  ]
}