Jump to

• Request
• Response
• Examples

Create a Metadata for a Key of a Device Specified by its ID

post

/iot/api/v2/devices/{entity-id}/metadata/{key}

Create a Metadata for a Key of a Device specified by ID

Request

Supported Media Types

• application/json
• text/plain

Path Parameters

• entity-id: string
  Specified device id
• key: string
  Metadata key

Body ()

Root Schema : SerializableMetadataKey_create

Type: object

Show Source

{
    "properties":{
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

200 Response

Successfully processed.

Body ()

Root Schema : SerializableMetadataKey_receive

Type: object

Show Source

{
    "properties":{
    },
    "type":"object"
}

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.

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.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.

Back to Top

Examples

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   https://iotserver/iot/api/v2/devices/{entity-id}/metadata/{key} 

Example of Request Body

The following example shows the content of the request body in JSON format

{
} 

Example of Response Body

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

{
    "links":[
        {
            "rel":"self",
            "href":"https://iotserver/iot/api/version/resource/path"
        },
        {
            "rel":"canonical",
            "href":"https://iotserver/iot/api/version/resource/path"
        }
    ]
} 

Complete cURL Example

The following example shows compete cURL comand that can be used to perform described operation

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json'  
   -d '{}'
   https://iotserver/iot/api/v2/devices/20d870f93f20-1106/metadata/key-name 

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