IBM InfoSphere Streams Version 4.1.1

Jobs

This collection resource provides access to information about the jobs that are running within the instance that you specify.

Universal Resource Identifier (URI) pattern

https://server:port/streams/rest/instances/{restid}/jobs

Properties

This collection resource has the following properties:
jobs
An array of job objects. For more information about the properties for each job object, see Job.
next
A string that represents 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 represents 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
A string that represents the REST resource type, which is jobList.
total
A number that represents 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:
host.restid
This command is deprecated and might become obsolete. Use the resource.restid parameter instead.
This parameter specifies the value of the restid property for an instance host. If this parameter is used, the list is limited to the jobs for the InfoSphere Streams resource that you specify.
For example:
GET https://server1:8443/streams/rest/instances/StreamsInstance/jobs?host.restid=1.2.3.4
resource.restid
This parameter specifies the value of the restid property for a resource that is allocated to the instance. If this parameter is used, the list is limited to the jobs with processing elements that run on the resource that you specify.
For example:
GET https://server1:8443/streams/rest/instances/StreamsInstance/jobs?resource.restid=server2.ibm.com