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.
; {
; "locationName": "sunt non",
; "portSpeedShapeName": "consequat magna",
; "compartmentId": "{{compartment_ocid}}",
; "crossConnectGroupId": "amet aute",
; "customerReferenceName": "veniam magna cillum aliquip",
; "definedTags": {},
; "displayName": "laborum velit commodo ad",
; "farCrossConnectOrCrossConnectGroupId": "enim ex si",
; "freeformTags": {},
; "nearCrossConnectOrCrossConnectGroupId": "adipisicing dolore"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"locationName","sunt non")
CkJsonObject::ckUpdateString(json,"portSpeedShapeName","consequat magna")
CkJsonObject::ckUpdateString(json,"compartmentId","{{compartment_ocid}}")
CkJsonObject::ckUpdateString(json,"crossConnectGroupId","amet aute")
CkJsonObject::ckUpdateString(json,"customerReferenceName","veniam magna cillum aliquip")
CkJsonObject::ckUpdateNewObject(json,"definedTags")
CkJsonObject::ckUpdateString(json,"displayName","laborum velit commodo ad")
CkJsonObject::ckUpdateString(json,"farCrossConnectOrCrossConnectGroupId","enim ex si")
CkJsonObject::ckUpdateNewObject(json,"freeformTags")
CkJsonObject::ckUpdateString(json,"nearCrossConnectOrCrossConnectGroupId","adipisicing dolore")
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/crossConnects","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": "eiusmod",
; "crossConnectGroupId": "in in esse reprehenderit",
; "customerReferenceName": "magna Excepteur aliqua pariatur est",
; "definedTags": {},
; "displayName": "adipisicing deserunt culpa nisi dolore",
; "freeformTags": {},
; "id": "amet cillum oc",
; "lifecycleState": "TERMINATING",
; "locationName": "id",
; "portName": "velit veniam sunt",
; "portSpeedShapeName": "culpa ullamco esse et",
; "timeCreated": "1954-06-26T01:15:04.287Z"
; }
; 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")
crossConnectGroupId.s = CkJsonObject::ckStringOf(jResp,"crossConnectGroupId")
customerReferenceName.s = CkJsonObject::ckStringOf(jResp,"customerReferenceName")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
id.s = CkJsonObject::ckStringOf(jResp,"id")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
locationName.s = CkJsonObject::ckStringOf(jResp,"locationName")
portName.s = CkJsonObject::ckStringOf(jResp,"portName")
portSpeedShapeName.s = CkJsonObject::ckStringOf(jResp,"portSpeedShapeName")
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 '{
"locationName": "sunt non",
"portSpeedShapeName": "consequat magna",
"compartmentId": "{{compartment_ocid}}",
"crossConnectGroupId": "amet aute",
"customerReferenceName": "veniam magna cillum aliquip",
"definedTags": {},
"displayName": "laborum velit commodo ad",
"farCrossConnectOrCrossConnectGroupId": "enim ex si",
"freeformTags": {},
"nearCrossConnectOrCrossConnectGroupId": "adipisicing dolore"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/crossConnects
Postman Collection Item JSON
{
"name": "CreateCrossConnect",
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"{{compartment_ocid}}\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
},
"description": "Creates a new cross-connect. Oracle recommends you create each cross-connect in a\n[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation\nwith the connection.\n\nAfter creating the `CrossConnect` object, you need to go the FastConnect location\nand request to have the physical cable installed. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect to reside. If you're\nnot sure which compartment to use, put the cross-connect in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n"
},
"response": [
{
"name": "The cross-connect was created.",
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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\": \"eiusmod\",\n \"crossConnectGroupId\": \"in in esse reprehenderit\",\n \"customerReferenceName\": \"magna Excepteur aliqua pariatur est\",\n \"definedTags\": {},\n \"displayName\": \"adipisicing deserunt culpa nisi dolore\",\n \"freeformTags\": {},\n \"id\": \"amet cillum oc\",\n \"lifecycleState\": \"TERMINATING\",\n \"locationName\": \"id\",\n \"portName\": \"velit veniam sunt\",\n \"portSpeedShapeName\": \"culpa ullamco esse et\",\n \"timeCreated\": \"1954-06-26T01:15:04.287Z\"\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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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": "Conflict",
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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": [
{
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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}"
}
]
}