IBM Streams 4.3.0

Device Manager REST API reference

IBM® Streams provides an application programming interface (API) that you can use to retrieve information about and submit commands to devices managed by a specific device management service. The API is based on the Representational State Transfer (REST) architectural principles and is implemented by using the HTTP protocol.

REST requests and responses deal with the transfer of representations of resources. Each resource is accessed by using a Uniform Resource Identifier (URI). IBM Streams provides support for individual element resources and collections of resources. Collection resources provide access to information about a list of objects of the same type, for example device types, devices, or commands submitted to a specific device type. Element resources provide access to information for a single object such as a specific device or device type.

URI patterns

The URI must contain the correct connection information to successfully call the API. The connection information consists of the host name where the device management service is running, and the port number that the service is using. These values are represented by the server and port variables in the URI examples.

The root URI for the Device Manager REST API is https://server:port/devmgmt. To determine the root URI, run the streamtool geturl command with the --deviceapi option.

Many of the URI patterns are documented with replacement values in braces ({}). For example:

https://server:port/devmgmt/appcfgs/{configname}/devicetypes/{devicetype}

Such a value must be replaced with the value of the property of the same name for an element resource

REST API responses

An HTTP status code and relevant HTTP response headers are returned for all Device Manager REST API requests. Extra content might also be returned in the message body and is returned in JavaScript Object Notation (JSON) format.