IBM Streams 4.3.0

Query parameters for element resources

You can add query parameters to the uniform resource identifiers (URI) for REST API element resources to tailor and filter the response output. All query parameter names and values are case-sensitive.

IBM® Streams ignores any unexpected query parameters or query parameter values.

Table 1. REST API query parameters for element resources
Query parameter name	Parameter value	Description
fields	A comma-separated list of property names.	This parameter filters the properties that are returned. To include a subset of the members of an object property, include the member name (as `object`.`member`) instead of the object property name. By default, all fields are returned.
verbose	Boolean	This parameter specifies to return more properties for the resource. The properties for which you must specify the verbose parameter are noted in the documentation for the REST API resources. By default, the parameter value is false.

Examples

Retrieve the name, health, and status properties for the job 1 in the StreamsInstance instance:

GET https://server1:8443/streams/rest/instances/StreamsInstance/jobs/1?fields=name,status,health

Retrieve all of the information for processing element (PE) 0 in the StreamsInstance instance:
```
GET https://server1:8443/streams/rest/instances/StreamsInstance/pes/0?verbose=true
```
The response to this request includes the restartPriority property value.