Jump to

• Request
• Response

Retrieve List of Common Device Metadata Keys

get

/iot/api/v2/devices/metadataTypes

Retrieve list of device metadata common keys

Request

Query Parameters

• expand(optional): string
  The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
• fields(optional): string
  The comma-separated list of fields to be shown in response. By default all response object fields will be present.
• limit(optional): integer
  The maximum number of entries to return to the end user.
• offset(optional): integer
  The number that the first record of results is starting from.
• orderBy(optional): string
  Setting order of the returned keys list
• q(optional): string
  Query to filter keys on the server (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
• since(optional): integer
  The starting point of the desired time interval, in milliseconds. The default is 0.
• totalResults(optional): boolean
  The total number of results suiting the request.
• until(optional): integer
  The finishing point of the desired time interval, in milliseconds. The default is 0.

Back to Top

Response

Supported Media Types

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

200 Response

Successfully processed.

Body ()

Root Schema : MetadataKeyImpl_receive

Type: object

Show Source

• name: string
  Property description was not set
• valueType: string
  One of [BOOLEAN, DATETIME, NUMBER, STRING, URI].

{
    "properties":{
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "valueType":{
            "description":"One of [BOOLEAN, DATETIME, NUMBER, STRING, URI].",
            "type":"string"
        }
    },
    "required":[
        "valueType",
        "name"
    ],
    "type":"object"
}

401 Response

Unauthorized. The request requires user authentication.

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