3.1 Understanding Representational State Transfer (REST)

REST is defined in Wikipedia as a term coined by Roy Fielding in his Ph.D. dissertation to describe an architecture style of networked systems.

The Web 2.0 Connect API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The REST model provides a loose coupled API is the easiest to make use of in applications, particularly Web applications that implement most of their operations in client side JavaScript.

The following resources are accessible through the RESTful model in Web 2.0 Connect:

  • element/alarms/{channel}/history

  • element/alarms/{channel}/realtime

  • element/attributes

  • element/children

  • element/childrenAttributes

  • element/find

  • element/impacted

  • element/name

  • element/parent

  • element/perform/{operationName}/execute

  • element/properties/pages

  • element/query/performance

  • element/query/performance/{profile}/{expression}/series/{dname}?from={fromDate}&to={toDate}&limit={return-points-limitation}

    Specify date formats as y-M-d-H-m-s, y-M-d H:m:s, or time in milliseconds.

  • element/related

  • element/relationship

  • element/relationships

  • element/rootcause

  • element/search

  • element/value

  • elementClass/{className}/metamodelPages

  • ping

  • session

NOTE:All resource parameter values, as indicated with curly braces above, should be URL encoded. For example, {channel} and {fromDate}.