Chilkat Online Tools

Foxpro / Core Services API / GetCrossConnectGroups

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCompartmentId
LOCAL lcCustomerReferenceName
LOCAL lcDisplayName
LOCAL lcId
LOCAL lcLifecycleState
LOCAL lcTimeCreated

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.SetRequestHeader("Authorization","{{signature}}")
loHttp.SetRequestHeader("Date","{{date}}")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/crossConnectGroups/:crossConnectGroupId",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

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

* {
*   "compartmentId": "mollit mini",
*   "customerReferenceName": "officia deserunt veniam amet",
*   "definedTags": {},
*   "displayName": "voluptate non en",
*   "freeformTags": {},
*   "id": "quis c",
*   "lifecycleState": "INACTIVE",
*   "timeCreated": "1949-09-29T22:08:43.421Z"
* }

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

lcCompartmentId = loJResp.StringOf("compartmentId")
lcCustomerReferenceName = loJResp.StringOf("customerReferenceName")
lcDisplayName = loJResp.StringOf("displayName")
lcId = loJResp.StringOf("id")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcTimeCreated = loJResp.StringOf("timeCreated")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/crossConnectGroups/:crossConnectGroupId

Postman Collection Item JSON

{
  "name": "GetCrossConnectGroups",
  "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}}/crossConnectGroups/:crossConnectGroupId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "crossConnectGroups",
        ":crossConnectGroupId"
      ],
      "variable": [
        {
          "key": "crossConnectGroupId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
        }
      ]
    },
    "description": "Gets the specified cross-connect group's information."
  },
  "response": [
    {
      "name": "The cross-connect group was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"mollit mini\",\n \"customerReferenceName\": \"officia deserunt veniam amet\",\n \"definedTags\": {},\n \"displayName\": \"voluptate non en\",\n \"freeformTags\": {},\n \"id\": \"quis c\",\n \"lifecycleState\": \"INACTIVE\",\n \"timeCreated\": \"1949-09-29T22:08:43.421Z\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}