Chilkat Online Tools

Swift / Core Services API / ListInstanceDevices

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("isAvailable", value: "true")
    queryParams.UpdateString("name", value: "et commod")
    queryParams.UpdateInt("limit", value: 801)
    queryParams.UpdateString("page", value: "laboris proident officia tempor")
    queryParams.UpdateString("sortBy", value: "TIMECREATED")
    queryParams.UpdateString("sortOrder", value: "DESC")

    http.SetRequestHeader("opc-request-id", value: "8wF")
    http.SetRequestHeader("Authorization", value: "{{signature}}")
    http.SetRequestHeader("Date", value: "{{date}}")

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://iaas.{{region}}.oraclecloud.com/20160918/instances/:instanceId/devices", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jarrResp = CkoJsonArray()
    jarrResp.LoadSb(sbResponseBody)
    jarrResp.EmitCompact = false

    print("Response Body:")
    print("\(jarrResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // [
    //   {
    //     "name": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isAvailable": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   },
    //   {
    //     "name": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isAvailable": {
    //       "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

    var json: CkoJsonObject?
    var Value: String?
    var isAvailableValue: String?

    var i: Int = 0
    var count_i: Int = jarrResp.Size.intValue
    while i < count_i {
        json = jarrResp.ObjectAt(i)
        Value = json!.StringOf("name.value")
        isAvailableValue = json!.StringOf("isAvailable.value")
        json = nil
        i = i + 1
    }


}

Curl Command

curl -G -d "isAvailable=true"
	-d "name=et%20commod"
	-d "limit=801"
	-d "page=laboris%20proident%20officia%20tempor"
	-d "sortBy=TIMECREATED"
	-d "sortOrder=DESC"
	-H "opc-request-id: 8wF"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/instances/:instanceId/devices

Postman Collection Item JSON

{
  "name": "ListInstanceDevices",
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "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}}/instances/:instanceId/devices?isAvailable=true&name=et commod&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "instances",
        ":instanceId",
        "devices"
      ],
      "query": [
        {
          "key": "isAvailable",
          "value": "true",
          "description": "A filter to return only available devices or only used devices.\n"
        },
        {
          "key": "name",
          "value": "et commod",
          "description": "A filter to return only devices that match the given name exactly.\n"
        },
        {
          "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": "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"
        }
      ],
      "variable": [
        {
          "key": "instanceId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
        }
      ]
    },
    "description": "Gets a list of all the devices for given instance. You can optionally filter results by device availability."
  },
  "response": [
    {
      "name": "List of devices",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/instances/:instanceId/devices?isAvailable=true&name=et commod&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instances",
            ":instanceId",
            "devices"
          ],
          "query": [
            {
              "key": "isAvailable",
              "value": "true"
            },
            {
              "key": "name",
              "value": "et commod"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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  \"name\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isAvailable\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"name\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isAvailable\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n]"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/instances/:instanceId/devices?isAvailable=true&name=et commod&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instances",
            ":instanceId",
            "devices"
          ],
          "query": [
            {
              "key": "isAvailable",
              "value": "true"
            },
            {
              "key": "name",
              "value": "et commod"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/instances/:instanceId/devices?isAvailable=true&name=et commod&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instances",
            ":instanceId",
            "devices"
          ],
          "query": [
            {
              "key": "isAvailable",
              "value": "true"
            },
            {
              "key": "name",
              "value": "et commod"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/instances/:instanceId/devices?isAvailable=true&name=et commod&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instances",
            ":instanceId",
            "devices"
          ],
          "query": [
            {
              "key": "isAvailable",
              "value": "true"
            },
            {
              "key": "name",
              "value": "et commod"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/instances/:instanceId/devices?isAvailable=true&name=et commod&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instances",
            ":instanceId",
            "devices"
          ],
          "query": [
            {
              "key": "isAvailable",
              "value": "true"
            },
            {
              "key": "name",
              "value": "et commod"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/instances/:instanceId/devices?isAvailable=true&name=et commod&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instances",
            ":instanceId",
            "devices"
          ],
          "query": [
            {
              "key": "isAvailable",
              "value": "true"
            },
            {
              "key": "name",
              "value": "et commod"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}