Jump to

• Request
• Response

Update or Delete Metadata for a Device by ID

post

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

This operation allows you to update or delete the metadata information of a device specified by its ID. You can delete the metadata information of a device by providing a list of the keys of the metadata to be Deleted.

Request

Supported Media Types

• application/json

Path Parameters

• entity-id: string
  Specified device id

Header Parameters

• X-HTTP-Method-Override: string
  To perform a partial update of the device metadata, POST request should be orchestrated with method override set to PATCH

Body ()

Root Schema : SerializableMetadata_update

Type: object

Show Source

• metadata: object metadata
  Additional Properties Allowed: additionalProperties

  Property description was not set
• operation: string
  One of [UPDATE, DELETE].

{
    "properties":{
        "metadata":{
            "additionalProperties":{
                "description":"A map of the following type: Map<String, String>",
                "type":"string"
            },
            "description":"Property description was not set",
            "properties":{
            },
            "type":"object"
        },
        "operation":{
            "description":"One of [UPDATE, DELETE].",
            "type":"string"
        }
    },
    "required":[
        "operation",
        "metadata"
    ],
    "type":"object"
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• string
  A map of the following type: Map<String, String>

{
    "additionalProperties":{
        "description":"A map of the following type: Map<String, String>",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Property description was not set

Show Source

{
    "additionalProperties":{
        "description":"A map of the following type: Map<String, String>",
        "type":"string"
    },
    "description":"Property description was not set",
    "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 : SerializableMetadata_receive

Type: object

Show Source

• metadata: object metadata
  Additional Properties Allowed: additionalProperties

  Property description was not set
• operation: string
  One of [UPDATE, DELETE].

{
    "properties":{
        "metadata":{
            "additionalProperties":{
                "description":"A map of the following type: Map<String, String>",
                "type":"string"
            },
            "description":"Property description was not set",
            "properties":{
            },
            "type":"object"
        },
        "operation":{
            "description":"One of [UPDATE, DELETE].",
            "type":"string"
        }
    },
    "required":[
        "operation",
        "metadata"
    ],
    "type":"object"
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• string
  A map of the following type: Map<String, String>

{
    "additionalProperties":{
        "description":"A map of the following type: Map<String, String>",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Property description was not set

Show Source

{
    "additionalProperties":{
        "description":"A map of the following type: Map<String, String>",
        "type":"string"
    },
    "description":"Property description was not set",
    "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.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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