IPA License Requirements: An IPA license is not required to call this method.
This method creates a subscription for information regarding Process Automation Server (PAS). Use the messaging API to retrieve any message representations that are provided by the server when the run state of PAS changes.
The server will provide representations when the watch is initially established, or any time pertinent information such as the current run state of PAS is changed. This API will initially include only information about the current run state of PAS (Running, Shutting Down, Shutdown). But, in the future, it is likely that it will be extended to include additional information such as what operations are currently being accepted by PAS (able to launch, able to do pickups, etc.) and indications about PAS warning and error conditions (running low on diskspace, running low on memory, PAS overloaded with too many processes, etc.).
Feature | Version | |
---|---|---|
ipa | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.The watch subscription to Process Automation Server status has been created. Expect a message object soon that will contain the initial run state.
Process Automation Server (PAS) has changed run state.
Required
The JSON type representing this option.Required
When true
, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false
, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false
to indicate the cache should be initialized with the data provided.
This property indicates the current run state of Process Automation Server (PAS).
Invalid session token in request.
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.IPA License Requirements: An IPA license is not required to call this method.
This method removes the subscription for information regarding Process Automation Server (PAS). Once the subscription is removed, PAS will not send any additional events -- not even to close a page that was still open.
Feature | Version | |
---|---|---|
ipa | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.The watch subscription to information regarding Process Automation Server (PAS) has been removed.
The watch subscription to information regarding Process Automation Server (PAS) run state does not exist for this session.
Required
A message that describes the current error.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.