Chilkat Online Tools

PureBasic / Core Services API / CreateVolumeBackupPolicyAssignment

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.

    ; {
    ;   "policyId": "laboris nostrud eu",
    ;   "assetId": "Lorem dolor minim anim quis"
    ; }

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

    CkJsonObject::ckUpdateString(json,"policyId","laboris nostrud eu")
    CkJsonObject::ckUpdateString(json,"assetId","Lorem dolor minim anim quis")

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

    resp.i = CkHttp::ckPostJson3(http,"https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackupPolicyAssignments","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        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(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "id": "sed sit ut Duis",
    ;   "policyId": "in Lorem ea",
    ;   "assetId": "consectetur",
    ;   "timeCreated": "2021-06-14T11:21:03.324Z"
    ; }

    ; 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")
    policyId.s = CkJsonObject::ckStringOf(jResp,"policyId")
    assetId.s = CkJsonObject::ckStringOf(jResp,"assetId")
    timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")


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


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "policyId": "laboris nostrud eu",
    "assetId": "Lorem dolor minim anim quis"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackupPolicyAssignments

Postman Collection Item JSON

{
  "name": "CreateVolumeBackupPolicyAssignment",
  "request": {
    "method": "POST",
    "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    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeBackupPolicyAssignments"
      ]
    },
    "description": "Assigns a volume backup policy to the specified volume. Note that a given volume can\nonly have one backup policy assigned to it. If this operation is used for a volume that already\nhas a different backup policy assigned, the prior backup policy will be silently unassigned.\n"
  },
  "response": [
    {
      "name": "The volume backup policy has been assigned.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicyAssignments"
          ]
        }
      },
      "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\": \"sed sit ut Duis\",\n \"policyId\": \"in Lorem ea\",\n \"assetId\": \"consectetur\",\n \"timeCreated\": \"2021-06-14T11:21:03.324Z\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicyAssignments"
          ]
        }
      },
      "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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicyAssignments"
          ]
        }
      },
      "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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicyAssignments"
          ]
        }
      },
      "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": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicyAssignments"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicyAssignments"
          ]
        }
      },
      "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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"policyId\": \"laboris nostrud eu\",\n    \"assetId\": \"Lorem dolor minim anim quis\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicyAssignments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicyAssignments"
          ]
        }
      },
      "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}"
    }
  ]
}