IBM Streams 4.2.1
REST API responses
The IBM®
Streams REST
API uses the HTTP protocol for sending and receiving data. An
HTTP status code and relevant HTTP response headers are returned for
all IBM
Streams REST
API requests. Extra content might also be returned in the message
body.
For successful requests, the content contains IBM
Streams configuration
and status information. For failed requests, the content contains
information about the failure.
All text messages and descriptions are returned in English, regardless of the value of the Accept-Language header.
The content that is returned by the REST API in the message body uses the JavaScript Object Notation (JSON) format. JSON is a lightweight data-interchange format that is easy for both humans and machines to read and process. You can use a wide variety of tools to parse content that is in JSON format. Links to tools and code libraries for various programming languages can be found at: www.json.org.
If
an error occurs, the REST API returns an HTTP error status code. If IBM
Streams product-specific
information about the failure is available, it is returned in the
message body. The error content contains a message identifier and
a text error message. For example:
{
"message": "CDISW5000E The resource with the instance resourceType and restid abc cannot be found.",
"id": "CDISW5000E"
}