Jump to

• Request
• Response
• Examples

View Information about Version 2 of the API

get

/productionMonitoring/clientapi/v2/

Returns detailed information about version 2 of Oracle IoT Production Monitoring Cloud Service REST API

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=collection

200 Response

Successfully processed.

Body ()

Root Schema : APIResourceVersionContext_receive

Type: object

Show Source

• latest: boolean
  Shows the version is the latest (true) or not (false)
• lifecycle: string
  Life cycle status of the version (active or deprecated)
• links: array links
  List of API resources
• version: string
  Version id

{
    "type":"object",
    "required":[
        "latest",
        "links",
        "lifecycle",
        "version"
    ],
    "properties":{
        "latest":{
            "type":"boolean",
            "description":"Shows the version is the latest (true) or not (false)"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/APIResource$APIInfo_receive"
            },
            "description":"List of API resources"
        },
        "lifecycle":{
            "type":"string",
            "description":"Life cycle status of the version (active or deprecated)"
        },
        "version":{
            "type":"string",
            "description":"Version id"
        }
    }
}

Nested Schema : links

Type: array

List of API resources

Show Source

• Array of: object APIResource$APIInfo_receive

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/APIResource$APIInfo_receive"
    },
    "description":"List of API resources"
}

Nested Schema : APIResource$APIInfo_receive

Type: object

Show Source

• name: string
  Property description was not set
• url: string
  Property description was not set

{
    "type":"object",
    "required":[
        "url",
        "name"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"Property description was not set"
        },
        "name":{
            "type":"string",
            "description":"Property description was not set"
        }
    }
}

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.

Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/productionMonitoring/clientapi/v2/ 

Example of Response Body

The following example shows the content of the response body in JSON format:

{
    "latest":false,
    "links":[
        {
            "url":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
            "name":"Property description was not set"
        }
    ],
    "lifecycle":"Life cycle status of the version (active or deprecated)",
    "version":"Version id"
} 

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/v2/ 

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.

Back to Top