Topics Resource

GET /topics

Returns the list of all the Topics that received some data for the account of the currently connected user. For each returned Topic, the topic string and timestamp of its last received message will be returned.

Request Parameters
name type description default constraints
limit query Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. 50 int
offset query Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. 0 int
prefix query Optional query parameter specifying a prefix for all the Topics returned. Only the Topics which start with the specified prefix will be returned.  
Response Body
media type data type description
application/json TopicsResult (JSON) The list of requested Topic objects.
application/xml topicsResult (XML)

Example

Request
GET /topics
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "topicInfo" : [ {
    "edcTopic" : {
      "systemTopic" : true,
      "edcTopic" : true,
      "alertTopic" : true,
      "account" : "...",
      "asset" : "...",
      "semanticTopic" : "...",
      "leafName" : "...",
      "parentTopic" : "...",
      "grandParentTopic" : "...",
      "fullTopic" : "...",
      "topicParts" : [ "...", "..." ]
    },
    "lastMessageOn" : 12345,
    "topic" : "..."
  }, {
    "edcTopic" : {
      "systemTopic" : true,
      "edcTopic" : true,
      "alertTopic" : true,
      "account" : "...",
      "asset" : "...",
      "semanticTopic" : "...",
      "leafName" : "...",
      "parentTopic" : "...",
      "grandParentTopic" : "...",
      "fullTopic" : "...",
      "topicParts" : [ "...", "..." ]
    },
    "lastMessageOn" : 12345,
    "topic" : "..."
  } ]
}
                
              

GET /topics/count

Returns the count of all the Messages published under the specified topic.

Request Parameters
name type description default
endDate query End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. If not specified it means current time. Alternatively, the date can be expressed as a string following the ISO 8601 format. 0
startDate query Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. If not specified it means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. 0
topic query  
Response Body
media type data type description
application/json CountResult (JSON) The count of requested Messages.
application/xml countResult (XML)

Example

Request
GET /topics/count
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "count" : 12345
}