Chilkat Online Tools

C# / Core Services API / ListDrgAttachments

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("compartmentId","{{compartment_ocid}}");
queryParams.UpdateString("vcnId","amet ut");
queryParams.UpdateString("drgId","amet ut");
queryParams.UpdateInt("limit",801);
queryParams.UpdateString("page","laboris proident officia tempor");
queryParams.UpdateString("networkId","amet ut");
queryParams.UpdateString("attachmentType","VCN");
queryParams.UpdateString("drgRouteTableId","amet ut");
queryParams.UpdateString("displayName","amet ut");
queryParams.UpdateString("sortBy","TIMECREATED");
queryParams.UpdateString("sortOrder","DESC");
queryParams.UpdateString("lifecycleState","ACTIVE");

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/drgAttachments",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonArray jarrResp = new Chilkat.JsonArray();
jarrResp.LoadSb(sbResponseBody);
jarrResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jarrResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

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

// [
//   {
//     "id": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "compartmentId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "drgId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "lifecycleState": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "definedTags": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "displayName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "drgRouteTableId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "exportDrgRouteDistributionId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "freeformTags": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "isCrossTenancy": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "networkDetails": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "routeTableId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "timeCreated": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "vcnId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   {
//     "id": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "compartmentId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "drgId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "lifecycleState": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "definedTags": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "displayName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "drgRouteTableId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "exportDrgRouteDistributionId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "freeformTags": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "isCrossTenancy": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "networkDetails": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "routeTableId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "timeCreated": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "vcnId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   }
// ]

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

Chilkat.JsonObject json = null;
string Value;
string compartmentIdValue;
string drgIdValue;
string lifecycleStateValue;
string definedTagsValue;
string displayNameValue;
string drgRouteTableIdValue;
string exportDrgRouteDistributionIdValue;
string freeformTagsValue;
string isCrossTenancyValue;
string networkDetailsValue;
string routeTableIdValue;
string timeCreatedValue;
string vcnIdValue;

int i = 0;
int count_i = jarrResp.Size;
while (i < count_i) {
    json = jarrResp.ObjectAt(i);
    Value = json.StringOf("id.value");
    compartmentIdValue = json.StringOf("compartmentId.value");
    drgIdValue = json.StringOf("drgId.value");
    lifecycleStateValue = json.StringOf("lifecycleState.value");
    definedTagsValue = json.StringOf("definedTags.value");
    displayNameValue = json.StringOf("displayName.value");
    drgRouteTableIdValue = json.StringOf("drgRouteTableId.value");
    exportDrgRouteDistributionIdValue = json.StringOf("exportDrgRouteDistributionId.value");
    freeformTagsValue = json.StringOf("freeformTags.value");
    isCrossTenancyValue = json.StringOf("isCrossTenancy.value");
    networkDetailsValue = json.StringOf("networkDetails.value");
    routeTableIdValue = json.StringOf("routeTableId.value");
    timeCreatedValue = json.StringOf("timeCreated.value");
    vcnIdValue = json.StringOf("vcnId.value");

    i = i + 1;
}

Curl Command

curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
	-d "vcnId=amet%20ut"
	-d "drgId=amet%20ut"
	-d "limit=801"
	-d "page=laboris%20proident%20officia%20tempor"
	-d "networkId=amet%20ut"
	-d "attachmentType=VCN"
	-d "drgRouteTableId=amet%20ut"
	-d "displayName=amet%20ut"
	-d "sortBy=TIMECREATED"
	-d "sortOrder=DESC"
	-d "lifecycleState=ACTIVE"
https://iaas.{{region}}.oraclecloud.com/20160918/drgAttachments

Postman Collection Item JSON

{
  "name": "ListDrgAttachments",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/drgAttachments?compartmentId={{compartment_ocid}}&vcnId=amet ut&drgId=amet ut&limit=801&page=laboris proident officia tempor&networkId=amet ut&attachmentType=VCN&drgRouteTableId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=ACTIVE",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "drgAttachments"
      ],
      "query": [
        {
          "key": "compartmentId",
          "value": "{{compartment_ocid}}",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
        },
        {
          "key": "vcnId",
          "value": "amet ut",
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
        },
        {
          "key": "drgId",
          "value": "amet ut",
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG."
        },
        {
          "key": "limit",
          "value": "801",
          "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
        },
        {
          "key": "page",
          "value": "laboris proident officia tempor",
          "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
        },
        {
          "key": "networkId",
          "value": "amet ut",
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG."
        },
        {
          "key": "attachmentType",
          "value": "VCN",
          "description": "The type for the network resource attached to the DRG."
        },
        {
          "key": "drgRouteTableId",
          "value": "amet ut",
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment."
        },
        {
          "key": "displayName",
          "value": "amet ut",
          "description": "A filter to return only resources that match the given display name exactly.\n"
        },
        {
          "key": "sortBy",
          "value": "TIMECREATED",
          "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n"
        },
        {
          "key": "sortOrder",
          "value": "DESC",
          "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
        },
        {
          "key": "lifecycleState",
          "value": "ACTIVE",
          "description": "A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
        }
      ]
    },
    "description": "Lists the `DrgAttachment` resource for the specified compartment. You can filter the\nresults by DRG, attached network, attachment type, DRG route table or\nVCN route table.\n\nThe LIST API lists DRG attachments by attachment type. It will default to list VCN attachments,\nbut you may request to list ALL attachments of ALL types. \n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/drgAttachments?compartmentId=amet ut&vcnId=amet ut&drgId=amet ut&limit=801&page=laboris proident officia tempor&networkId=amet ut&attachmentType=VCN&drgRouteTableId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgAttachments"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "vcnId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "networkId",
              "value": "amet ut"
            },
            {
              "key": "attachmentType",
              "value": "VCN"
            },
            {
              "key": "drgRouteTableId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            },
            {
              "key": "lifecycleState",
              "value": "officia sed"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-next-page",
          "value": "officia sed",
          "description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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 {\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"drgId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"lifecycleState\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"definedTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"displayName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"drgRouteTableId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"exportDrgRouteDistributionId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"freeformTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isCrossTenancy\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkDetails\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"routeTableId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"timeCreated\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"vcnId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"drgId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"lifecycleState\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"definedTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"displayName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"drgRouteTableId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"exportDrgRouteDistributionId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"freeformTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isCrossTenancy\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkDetails\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"routeTableId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"timeCreated\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"vcnId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n]"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/drgAttachments?compartmentId=amet ut&vcnId=amet ut&drgId=amet ut&limit=801&page=laboris proident officia tempor&networkId=amet ut&attachmentType=VCN&drgRouteTableId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgAttachments"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "vcnId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "networkId",
              "value": "amet ut"
            },
            {
              "key": "attachmentType",
              "value": "VCN"
            },
            {
              "key": "drgRouteTableId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            },
            {
              "key": "lifecycleState",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}}/drgAttachments?compartmentId=amet ut&vcnId=amet ut&drgId=amet ut&limit=801&page=laboris proident officia tempor&networkId=amet ut&attachmentType=VCN&drgRouteTableId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgAttachments"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "vcnId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "networkId",
              "value": "amet ut"
            },
            {
              "key": "attachmentType",
              "value": "VCN"
            },
            {
              "key": "drgRouteTableId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            },
            {
              "key": "lifecycleState",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}}/drgAttachments?compartmentId=amet ut&vcnId=amet ut&drgId=amet ut&limit=801&page=laboris proident officia tempor&networkId=amet ut&attachmentType=VCN&drgRouteTableId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgAttachments"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "vcnId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "networkId",
              "value": "amet ut"
            },
            {
              "key": "attachmentType",
              "value": "VCN"
            },
            {
              "key": "drgRouteTableId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            },
            {
              "key": "lifecycleState",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}}/drgAttachments?compartmentId=amet ut&vcnId=amet ut&drgId=amet ut&limit=801&page=laboris proident officia tempor&networkId=amet ut&attachmentType=VCN&drgRouteTableId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgAttachments"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "vcnId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "networkId",
              "value": "amet ut"
            },
            {
              "key": "attachmentType",
              "value": "VCN"
            },
            {
              "key": "drgRouteTableId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            },
            {
              "key": "lifecycleState",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}"
    }
  ]
}