Chilkat Online Tools

delphiAx / Core Services API / GetVirtualCircuit

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
value: WideString;
strVal: WideString;
bandwidthShapeName: WideString;
bgpManagement: WideString;
bgpSessionState: WideString;
compartmentId: WideString;
customerBgpAsn: Integer;
displayName: WideString;
gatewayId: WideString;
id: WideString;
lifecycleState: WideString;
oracleBgpAsn: Integer;
providerName: WideString;
providerServiceId: WideString;
providerServiceKeyName: WideString;
providerServiceName: WideString;
providerState: WideString;
referenceComment: WideString;
region: WideString;
serviceType: WideString;
timeCreated: WideString;
v_type: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

http.SetRequestHeader('Authorization','{{signature}}');
http.SetRequestHeader('Date','{{date}}');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://iaas.{{region}}.oraclecloud.com/20160918/virtualCircuits/:virtualCircuitId',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

// {
//   "bandwidthShapeName": "aliquip quis",
//   "bgpManagement": "PROVIDER_MANAGED",
//   "bgpSessionState": "UP",
//   "compartmentId": "ex voluptate ea eiusmod",
//   "crossConnectMappings": [
//     {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   ],
//   "customerBgpAsn": 32592947,
//   "definedTags": {},
//   "displayName": "sunt exercitation",
//   "freeformTags": {},
//   "gatewayId": "sed deserunt magna",
//   "id": "ex Duis amet culpa",
//   "lifecycleState": "PROVISIONING",
//   "oracleBgpAsn": 34318225,
//   "providerName": "ullamco occaecat culpa cillum",
//   "providerServiceId": "nisi ex culpa dolor",
//   "providerServiceKeyName": "nostru",
//   "providerServiceName": "laboris labore",
//   "providerState": "ACTIVE",
//   "publicPrefixes": [
//     "proident et amet qui dolor",
//     "tempor nostrud"
//   ],
//   "referenceComment": "laboris fugiat do",
//   "region": "dolore sint ut non",
//   "routingPolicy": [
//     "MARKET_LEVEL",
//     "GLOBAL"
//   ],
//   "serviceType": "LAYER2",
//   "timeCreated": "2021-02-05T13:31:56.554Z",
//   "type": "PUBLIC"
// }

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

bandwidthShapeName := jResp.StringOf('bandwidthShapeName');
bgpManagement := jResp.StringOf('bgpManagement');
bgpSessionState := jResp.StringOf('bgpSessionState');
compartmentId := jResp.StringOf('compartmentId');
customerBgpAsn := jResp.IntOf('customerBgpAsn');
displayName := jResp.StringOf('displayName');
gatewayId := jResp.StringOf('gatewayId');
id := jResp.StringOf('id');
lifecycleState := jResp.StringOf('lifecycleState');
oracleBgpAsn := jResp.IntOf('oracleBgpAsn');
providerName := jResp.StringOf('providerName');
providerServiceId := jResp.StringOf('providerServiceId');
providerServiceKeyName := jResp.StringOf('providerServiceKeyName');
providerServiceName := jResp.StringOf('providerServiceName');
providerState := jResp.StringOf('providerState');
referenceComment := jResp.StringOf('referenceComment');
region := jResp.StringOf('region');
serviceType := jResp.StringOf('serviceType');
timeCreated := jResp.StringOf('timeCreated');
v_type := jResp.StringOf('type');
i := 0;
count_i := jResp.SizeOfArray('crossConnectMappings');
while i < count_i do
  begin
    jResp.I := i;
    value := jResp.StringOf('crossConnectMappings[i].value');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('publicPrefixes');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('publicPrefixes[i]');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('routingPolicy');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('routingPolicy[i]');
    i := i + 1;
  end;

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetVirtualCircuit",
  "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}}/virtualCircuits/:virtualCircuitId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "virtualCircuits",
        ":virtualCircuitId"
      ],
      "variable": [
        {
          "key": "virtualCircuitId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
        }
      ]
    },
    "description": "Gets the specified virtual circuit's information."
  },
  "response": [
    {
      "name": "The virtual circuit was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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 \"bandwidthShapeName\": \"aliquip quis\",\n \"bgpManagement\": \"PROVIDER_MANAGED\",\n \"bgpSessionState\": \"UP\",\n \"compartmentId\": \"ex voluptate ea eiusmod\",\n \"crossConnectMappings\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"customerBgpAsn\": 32592947,\n \"definedTags\": {},\n \"displayName\": \"sunt exercitation\",\n \"freeformTags\": {},\n \"gatewayId\": \"sed deserunt magna\",\n \"id\": \"ex Duis amet culpa\",\n \"lifecycleState\": \"PROVISIONING\",\n \"oracleBgpAsn\": 34318225,\n \"providerName\": \"ullamco occaecat culpa cillum\",\n \"providerServiceId\": \"nisi ex culpa dolor\",\n \"providerServiceKeyName\": \"nostru\",\n \"providerServiceName\": \"laboris labore\",\n \"providerState\": \"ACTIVE\",\n \"publicPrefixes\": [\n  \"proident et amet qui dolor\",\n  \"tempor nostrud\"\n ],\n \"referenceComment\": \"laboris fugiat do\",\n \"region\": \"dolore sint ut non\",\n \"routingPolicy\": [\n  \"MARKET_LEVEL\",\n  \"GLOBAL\"\n ],\n \"serviceType\": \"LAYER2\",\n \"timeCreated\": \"2021-02-05T13:31:56.554Z\",\n \"type\": \"PUBLIC\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}