Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jarrResp: HCkJsonArray;
respStatusCode: Integer;
json: HCkJsonObject;
Value: PWideChar;
idValue: PWideChar;
lifecycleStateValue: PWideChar;
vcnIdValue: PWideChar;
blockTrafficValue: PWideChar;
servicesValue: PWideChar;
definedTagsValue: PWideChar;
displayNameValue: PWideChar;
freeformTagsValue: PWideChar;
routeTableIdValue: PWideChar;
timeCreatedValue: PWideChar;
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 := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'compartmentId','{{compartment_ocid}}');
CkJsonObject_UpdateInt(queryParams,'limit',801);
CkJsonObject_UpdateString(queryParams,'sortBy','TIMECREATED');
CkJsonObject_UpdateString(queryParams,'sortOrder','DESC');
CkHttp_SetRequestHeader(http,'Authorization','{{signature}}');
CkHttp_SetRequestHeader(http,'Date','{{date}}');
resp := CkHttp_QuickRequestParams(http,'GET','https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jarrResp := CkJsonArray_Create();
CkJsonArray_LoadSb(jarrResp,sbResponseBody);
CkJsonArray_putEmitCompact(jarrResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonArray__emit(jarrResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vcnId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "blockTraffic": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "services": {
// "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>"
// },
// "freeformTags": {
// "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>"
// }
// },
// {
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vcnId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "blockTraffic": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "services": {
// "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>"
// },
// "freeformTags": {
// "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>"
// }
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i := 0;
count_i := CkJsonArray_getSize(jarrResp);
while i < count_i do
begin
json := CkJsonArray_ObjectAt(jarrResp,i);
Value := CkJsonObject__stringOf(json,'compartmentId.value');
idValue := CkJsonObject__stringOf(json,'id.value');
lifecycleStateValue := CkJsonObject__stringOf(json,'lifecycleState.value');
vcnIdValue := CkJsonObject__stringOf(json,'vcnId.value');
blockTrafficValue := CkJsonObject__stringOf(json,'blockTraffic.value');
servicesValue := CkJsonObject__stringOf(json,'services.value');
definedTagsValue := CkJsonObject__stringOf(json,'definedTags.value');
displayNameValue := CkJsonObject__stringOf(json,'displayName.value');
freeformTagsValue := CkJsonObject__stringOf(json,'freeformTags.value');
routeTableIdValue := CkJsonObject__stringOf(json,'routeTableId.value');
timeCreatedValue := CkJsonObject__stringOf(json,'timeCreated.value');
CkJsonObject_Dispose(json);
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonArray_Dispose(jarrResp);
Curl Command
curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "limit=801"
-d "sortBy=TIMECREATED"
-d "sortOrder=DESC"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways
Postman Collection Item JSON
{
"name": "ListServiceGateways",
"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}}/serviceGateways?compartmentId={{compartment_ocid}}&limit=801&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways"
],
"query": [
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"key": "vcnId",
"value": "ocid1.vcn.oc1....",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
"disabled": true
},
{
"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",
"disabled": true
},
{
"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": "AVAILABLE",
"description": "A filter to return only resources that match the given lifecycle\nstate. The state value is case-insensitive.\n",
"disabled": true
}
]
},
"description": "Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/serviceGateways?compartmentId=amet ut&vcnId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"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 \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"id\": {\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 \"vcnId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"blockTraffic\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"services\": {\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 \"freeformTags\": {\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 },\n {\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"id\": {\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 \"vcnId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"blockTraffic\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"services\": {\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 \"freeformTags\": {\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 }\n]"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/serviceGateways?compartmentId=amet ut&vcnId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"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}}/serviceGateways?compartmentId=amet ut&vcnId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"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}}/serviceGateways?compartmentId=amet ut&vcnId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"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}}/serviceGateways?compartmentId=amet ut&vcnId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"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}"
}
]
}
