PureBasic / Core Services API / CreateAppCatalogSubscription
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.
; {
; "compartmentId": "{{compartment_ocid}}",
; "listingId": "elit ad mollit",
; "listingResourceVersion": "labore",
; "oracleTermsOfUseLink": "Duis in deserunt est quis",
; "timeRetrieved": "1994-10-28T17:14:58.966Z",
; "signature": "est in",
; "eulaLink": "occaecat"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"compartmentId","{{compartment_ocid}}")
CkJsonObject::ckUpdateString(json,"listingId","elit ad mollit")
CkJsonObject::ckUpdateString(json,"listingResourceVersion","labore")
CkJsonObject::ckUpdateString(json,"oracleTermsOfUseLink","Duis in deserunt est quis")
CkJsonObject::ckUpdateString(json,"timeRetrieved","1994-10-28T17:14:58.966Z")
CkJsonObject::ckUpdateString(json,"signature","est in")
CkJsonObject::ckUpdateString(json,"eulaLink","occaecat")
CkHttp::ckSetRequestHeader(http,"opc-retry-token","aliqua enim i")
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/appCatalogSubscriptions","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)
; {
; "compartmentId": "dolor",
; "displayName": "enim amet occaecat",
; "listingId": "Ut in do labore mollit",
; "listingResourceId": "mollit nisi",
; "listingResourceVersion": "Ut reprehenderit consequat in nulla",
; "publisherName": "laborum exercitation ex",
; "summary": "nulla ea",
; "timeCreated": "1977-06-11T17:39:36.553Z"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
listingId.s = CkJsonObject::ckStringOf(jResp,"listingId")
listingResourceId.s = CkJsonObject::ckStringOf(jResp,"listingResourceId")
listingResourceVersion.s = CkJsonObject::ckStringOf(jResp,"listingResourceVersion")
publisherName.s = CkJsonObject::ckStringOf(jResp,"publisherName")
summary.s = CkJsonObject::ckStringOf(jResp,"summary")
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 "opc-retry-token: aliqua enim i"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"compartmentId": "{{compartment_ocid}}",
"listingId": "elit ad mollit",
"listingResourceVersion": "labore",
"oracleTermsOfUseLink": "Duis in deserunt est quis",
"timeRetrieved": "1994-10-28T17:14:58.966Z",
"signature": "est in",
"eulaLink": "occaecat"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/appCatalogSubscriptions
Postman Collection Item JSON
{
"name": "CreateAppCatalogSubscription",
"request": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
},
{
"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 \"compartmentId\": \"{{compartment_ocid}}\",\n \"listingId\": \"elit ad mollit\",\n \"listingResourceVersion\": \"labore\",\n \"oracleTermsOfUseLink\": \"Duis in deserunt est quis\",\n \"timeRetrieved\": \"1994-10-28T17:14:58.966Z\",\n \"signature\": \"est in\",\n \"eulaLink\": \"occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/appCatalogSubscriptions",
"host": [
"{{baseUrl}}"
],
"path": [
"appCatalogSubscriptions"
]
},
"description": "Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.\n"
},
"response": [
{
"name": "The resource version was successfully subscribed to.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"tempor consequat non nostrud\",\n \"listingId\": \"elit ad mollit\",\n \"listingResourceVersion\": \"labore\",\n \"oracleTermsOfUseLink\": \"Duis in deserunt est quis\",\n \"timeRetrieved\": \"1994-10-28T17:14:58.966Z\",\n \"signature\": \"est in\",\n \"eulaLink\": \"occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/appCatalogSubscriptions",
"host": [
"{{baseUrl}}"
],
"path": [
"appCatalogSubscriptions"
]
}
},
"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\",\n \"displayName\": \"enim amet occaecat\",\n \"listingId\": \"Ut in do labore mollit\",\n \"listingResourceId\": \"mollit nisi\",\n \"listingResourceVersion\": \"Ut reprehenderit consequat in nulla\",\n \"publisherName\": \"laborum exercitation ex\",\n \"summary\": \"nulla ea\",\n \"timeCreated\": \"1977-06-11T17:39:36.553Z\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"tempor consequat non nostrud\",\n \"listingId\": \"elit ad mollit\",\n \"listingResourceVersion\": \"labore\",\n \"oracleTermsOfUseLink\": \"Duis in deserunt est quis\",\n \"timeRetrieved\": \"1994-10-28T17:14:58.966Z\",\n \"signature\": \"est in\",\n \"eulaLink\": \"occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/appCatalogSubscriptions",
"host": [
"{{baseUrl}}"
],
"path": [
"appCatalogSubscriptions"
]
}
},
"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": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"tempor consequat non nostrud\",\n \"listingId\": \"elit ad mollit\",\n \"listingResourceVersion\": \"labore\",\n \"oracleTermsOfUseLink\": \"Duis in deserunt est quis\",\n \"timeRetrieved\": \"1994-10-28T17:14:58.966Z\",\n \"signature\": \"est in\",\n \"eulaLink\": \"occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/appCatalogSubscriptions",
"host": [
"{{baseUrl}}"
],
"path": [
"appCatalogSubscriptions"
]
}
},
"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": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"tempor consequat non nostrud\",\n \"listingId\": \"elit ad mollit\",\n \"listingResourceVersion\": \"labore\",\n \"oracleTermsOfUseLink\": \"Duis in deserunt est quis\",\n \"timeRetrieved\": \"1994-10-28T17:14:58.966Z\",\n \"signature\": \"est in\",\n \"eulaLink\": \"occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/appCatalogSubscriptions",
"host": [
"{{baseUrl}}"
],
"path": [
"appCatalogSubscriptions"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"tempor consequat non nostrud\",\n \"listingId\": \"elit ad mollit\",\n \"listingResourceVersion\": \"labore\",\n \"oracleTermsOfUseLink\": \"Duis in deserunt est quis\",\n \"timeRetrieved\": \"1994-10-28T17:14:58.966Z\",\n \"signature\": \"est in\",\n \"eulaLink\": \"occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/appCatalogSubscriptions",
"host": [
"{{baseUrl}}"
],
"path": [
"appCatalogSubscriptions"
]
}
},
"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": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"tempor consequat non nostrud\",\n \"listingId\": \"elit ad mollit\",\n \"listingResourceVersion\": \"labore\",\n \"oracleTermsOfUseLink\": \"Duis in deserunt est quis\",\n \"timeRetrieved\": \"1994-10-28T17:14:58.966Z\",\n \"signature\": \"est in\",\n \"eulaLink\": \"occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/appCatalogSubscriptions",
"host": [
"{{baseUrl}}"
],
"path": [
"appCatalogSubscriptions"
]
}
},
"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}"
}
]
}
