1. REST API for Oracle Internet of Things Cloud Service
  2. Tasks
  3. IoT Device Models

Retrieve Formats of the Device Model

get

/iot/api/v2/deviceModels/{urn}/formats

Lists formats of the device model

Request

Path Parameters
  • URN of the device model for which formats should be listed
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : MessageFormatImpl_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : MessageFormatValue_receive
Type: object
Show Source
Nested Schema : fields
Type: array
Property description was not set
Show Source
Nested Schema : MessageFormatField_receive
Type: object
Show Source

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

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/iot/api/v2/deviceModels/{urn}/formats

Example of Response Body

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


{
    "items":[
        {
            "urn":"urn:example:unique:identifier:of:the:resource:7a56",
            "name":"Message format name",
            "description":"Message format description",
            "type":"Message format typeOne of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].",
            "deviceModel":"Device model that created this message format",
            "value":{
                "fields":[
                    {
                        "optional":false,
                        "name":"Name of the message format field. Name can contain only A-Z, a-z, 0-9 or underscore (_) characters.",
                        "type":"Type of the message format fieldOne of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
                    }
                ]
            },
            "explorationID":"ID of an exploration assocoated with the message format",
            "severity":"The severity of exploration's alert message format",
            "sourceType":"Type of the source from which format was createdOne of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].",
            "sourceId":"472240fa50e1-25c7"
        },
        {
            "urn":"urn:example:unique:identifier:of:the:resource:7bcb",
            "name":"Message format name",
            "description":"Message format description",
            "type":"Message format typeOne of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].",
            "deviceModel":"Device model that created this message format",
            "value":{
                "fields":[
                    {
                        "optional":false,
                        "name":"Name of the message format field. Name can contain only A-Z, a-z, 0-9 or underscore (_) characters.",
                        "type":"Type of the message format fieldOne of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
                    }
                ]
            },
            "explorationID":"ID of an exploration assocoated with the message format",
            "severity":"The severity of exploration's alert message format",
            "sourceType":"Type of the source from which format was createdOne of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].",
            "sourceId":"61ad484c4ceb-647f"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"https://iotserver/iot/api/version/resource/path"
        },
        {
            "rel":"canonical",
            "href":"https://iotserver/iot/api/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/iot/api/v2/deviceModels/urn:example:unique:identifier:of:the:resource:1a8c/formats



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