IBM Streams 4.3.0
Active view
Note: This
REST API resource is deprecated and might become obsolete. Use the view element
resource instead.
This deprecated element
resource provides access to information about a view that is active.
An
active view buffers stream data for a job. A view becomes active when
a configured view is started and a job is running for the application
that is specified in the configured view. If multiple jobs are running
for the application, you can have multiple active views that are associated
with a single configured view. When the view is stopped, there are
no active views.Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/activeviews/{restid}Properties
This element resource has the
following properties:
- configuredView
- A string that identifies the URI that you can use to access information about the configured view.
- id
- A string that represents the system-generated identifier that is used to uniquely identify the active view. The identifier is generated when the view is started. You can use the active view collection resource to retrieve active view identifiers.
- job
- A string that identifies the URI that you can use to access information about the job that contains the viewable data stream.
- ports
- A string that identifies the URI that you can use to access information about the output ports that are associated with the viewable data stream.
- resourceType
- A string that identifies the REST resource type, which is activeView.
- restid
- A string that represents the identifier that is used to uniquely identify the active view within a URI. The value of this property is the same as the value of the id property.
- self
- A string that identifies the URI for this resource.
- viewItems
- A string that identifies the URI that you can use to access information about the data items that are buffered by the active view.
Resource retrieval
You can use the following HTTP methods and query parameters to retrieve this resource:
- HTTP methods
- GET
- Query parameters
- This element resource supports the standard query parameters for element resources.