IBM Streams 4.3.0
Operators
This collection resource provides access to information about the operators in the instance that you specify.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/operatorsProperties
This collection resource has
the following properties:
- operators
- An array of operator objects.
- next
- A string that identifies the URI for the next page in the list. This property is not present if the list is not paged or if the current page is the last page.
- previous
- A string that identifies the URI for the previous page in the list. This property is not present if the list is not paged or if the current page is the first page.
- resourceType
- The string that identifies the REST resource type, which is operatorList.
- total
- A number that identifies the total number of objects in the list. If the list is filtered, the total corresponds to the total number of items that match the filter parameters.
Resource retrieval
You can use the following HTTP methods and query parameters to retrieve this resource:
- HTTP methods
- GET
- Query parameters
- This collection resource supports the standard query
parameters for collection resources. The following query parameters
are also supported for the collection resource:
- job.restid
- This parameter specifies the value of the restid property for a job resource. If this parameter is used,
the list is limited to the operators for the job that you specify. For example:
GET https://server1:8443/streams/rest/instances/StreamsInstance/operators?job.restid=123 - pe.restid
- This parameter specifies the value of the restid property for a processing element (PE) resource. If this
parameter is used, the list is limited to the operators for the PE that you specify. For example:
GET https://server1:8443/streams/rest/instances/StreamsInstance/operators?pe.restid=456