Subscribe devices to metadata alerts

Request

To subscribe one or more devices to the metadata alerts topic, send a PUT request to:

http://<host>:<port>/mib/v1/topics/MetaDataChanges/devices

This is an operator API and should not be called from a client application.

It is typically called from an operator's CRM system.

Headers

• Content-Type: application/json

Mandatory fields

• topicName (in both URL and payload) – the name of the topic (in this case, MetaDataChanges)
• active – set to true to leave the topic active, or to activate it if it is not active. (true is the default.)
• devices – one object for each device to be subscribed, containing at least:
  • deviceId – the unique ID of the device
  • subscriptionStatus – set this to true to subscribe the device.

Example

A request with this payload subscribes the specified devices to the MetaDataChanges topic:

{
  "topicName": "MetaDataChanges",
  "active": true,
  "devices": [
    {
      "deviceId": "59bb5fbbc6f9d5000801ae28",
      "subscriptionStatus": true
    },
    {
      "deviceId": "59bb5fbbc6f9d5000801ae29",
      "subscriptionStatus": true
    },
    {
      "deviceId": "59bb5fbbc6f9d5000801ae30",
      "subscriptionStatus": true
    }
  ]
}

The devices must already be registered with DMM. See Registering a device.

Response

A successful request returns an HTTP 200 status.

An unsuccessful request returns an HTTP 404 status if the topic does not exist.

See also

For full details of this API, see the DMM API documentation.