IPA License Requirements: An IPA license is not required to call this method.
This method creates a subscription for the list of process definitions that are launchable by the user associated with the current session. Use the messaging API to retrieve any message representations that are provided by the server when the list of launchable processes changes.
The server will provide representations when the subscription is initially established, when a process definition becomes launchable or unlaunchable, or when the description of the process definition changes. A process definition may become launchable when it is initially published, when the it gets changed to the active state, or when ACLs are changed such that the user now has rights to launch a new process instance from that process definition. Similarly, a process becomes unlaunchable if the process definition is deleted or deactivated, or if the ACLs are changed such that the user no longer has access to launch a new process instance for that process definition.
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 the list of launchable processes for the current user has been created. Expect a message representation soon if the user has one or more launchable processes.
The list of launchable processes for the current user has changed.
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 contains the list of processes definitions that have just become launchable by the current user. The process may have just been published or activated, the user may have just been granted the appropriate ACLs, etc.
Property type documentation:
This object defines a list of processDefinitionDescription objects.
List item type documentation:
This object contains information that identifies and describes a specific revision of a process definition.
Required
This is the ID associated with the process definition. This ID does not change as new revisions of the process are created, modified or published.
Required
This is the revision of the process indicated by the processDefinitionId. Each different published version of the same process will have the same processDefinitionId, but will have a different revision.
Required
This is the current name of the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current name.
Required
This is the current description the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current description.
This property contains the list of processes definitions that are already launchable by the current user, but just had a revision, name or description change.
Property type documentation:
This object defines a list of processDefinitionDescription objects.
List item type documentation:
This object contains information that identifies and describes a specific revision of a process definition.
This property contains the list of IDs for the process definitions that were previously launchable by the current user, but are no longer launchable by that user. The process may have been deactivated or deleted, the user may no longer have the appropriate ACLs, etc.
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 the list of processes that are launchable by the user associated with the current session.
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 the list of launchable processes for the current user has been removed.
The watch subscription to the list of launchable processes for the current user 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.