View Available API Versions
get
/productionMonitoring/clientapi/
Returns a JSON document that describes all available versions of the Oracle IoT Cloud Service REST API. The request returns a different attribute for each version number, and the returned JSON document contains a nested JSON object with a canonical link to additional information about that particular REST API version, along with documentation or other information.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : APIResourceVersionInfo_receive_list
Type:
Show Source
object
-
count:
integer(int32)
-
hasMore:
boolean
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
The set of API navigation links.
-
offset:
integer(int32)
Nested Schema : items
Type:
Show Source
object
-
latest:
boolean
Shows the version is the latest (true) or not (false)
-
lifecycle:
string
Life cycle status of the version (active or deprecated)
-
version:
string
Version id
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
406 Response
Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/clientapi/
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"items":[
{
"latest":false,
"lifecycle":"Life cycle status of the version (active or deprecated)",
"version":"Version id"
},
{
"latest":false,
"lifecycle":"Life cycle status of the version (active or deprecated)",
"version":"Version id"
}
],
"links":[
{
"rel":"self",
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path"
},
{
"rel":"canonical",
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path"
}
],
"count":2,
"limit":10,
"offset":0,
"hasMore":false
}
Complete cURL Example
The following example shows a complete cURL command that you can use to perform the described operation:
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/clientapi/
Note that in the request,
https://iotserver
will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is
https://myinstance-myidentitydomain.iot.us.oraclecloud.com
and the default port is 443.