API Catalog

Authentication APIs

ECX Fabric APIs

Customer Portal APIs

Network Edge APIs

IBX SmartView APIs

Catalog

FeedSubscriptions_v1

GET/feedsubscription/v1/subscribe
view all realtime feeds subscription with details
The subscribe GET endpoint allows users to view their resp. realtime feeds subscription details. Lists events currently subscribed to.

Parameters

Name Description
Authorization *
string
(header)

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Code Description
200
topic subscription details with details of any events that could not be subscribed to.
{
  "power": [
    {
      "accountNo": "string",
      "ibx": "string"
    }
  ],
  "asset": [
    {
      "accountNo": "string",
      "ibx": "string"
    }
  ],
  "subscriptionID": 0,
  "config": {
    "provider": "GOOGLE",
    "method": "PULL",
    "pushurl": "string"
  },
  "status": "OK",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "more_info": "string",
      "data": {
        "additionalProp1": {}
      }
    }
  ]
}
default
Unexpected error
{
  "code": "string",
  "message": "string",
  "more_info": "string",
  "data": {
    "additionalProp1": {}
  }
}
POST/feedsubscription/v1/subscribe
register for realtime DCIM feeds
DELETE/feedsubscription/v1/subscribe
request to close a realtime feed
PUT/feedsubscription/v1/subscribe/{subscriptionId}
update existing subscription to realtime DCIM Feeds
GET/feedsubscription/v1/subscribe/{subscriptionId}
view realtime feeds subscription details
The subscribe GET endpoint allows users to view their resp. realtime feeds subscription details. Lists events currently subscribed to.

Parameters

Name Description
Authorization *
string
(header)

Specify the OAuth Bearer token with prefix 'Bearer '.
subscriptionId *
string
(path)
unique identifier for the subscription

Responses

Code Description
200
topic subscription details with details of any events that could not be subscribed to.
{
  "power": [
    {
      "accountNo": "string",
      "ibx": "string"
    }
  ],
  "asset": [
    {
      "accountNo": "string",
      "ibx": "string"
    }
  ],
  "subscriptionID": 0,
  "config": {
    "provider": "GOOGLE",
    "method": "PULL",
    "pushurl": "string"
  },
  "status": "OK",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "more_info": "string",
      "data": {
        "additionalProp1": {}
      }
    }
  ]
}
default
Unexpected error
{
  "code": "string",
  "message": "string",
  "more_info": "string",
  "data": {
    "additionalProp1": {}
  }
}