listAdhocActivities

Lists all ad-hoc activities associated with either the specified process ID or global data reference.

  • The request includes either a process instance or a global data reference.
  • If a process ID is passed in the request, the response lists all ad-hoc activities associated with the identified process instance. If a global data reference is passed in the request, the response lists all ad-hoc activities for all process instances that reference the global data. The response includes the following:
    • activity - The name of the ad-hoc activity.
    • processID - Identifies the process instance associated with the ad-hoc activity.
    • enabled - True if the ad-hoc activity is enabled. For manual ad-hoc activities, once enabled, the activity can be invoked with runAdhocActivity. For automatic ad-hoc activities, once enabled, the activity is automatically invoked.

      Ad-hoc activities are enabled when any of the initializer activities specified in the ad-hoc activity have completed, and a pre-condition specified in the ad-hoc activity has transitioned from false to true.

    • inProgress - True if the ad-hoc activity is currently active.
    • repeatable - True if the ad-hoc activity can be invoked multiple times. Only applicable to manual ad-hoc activities; by default, automatic ad-hoc activities can be invoked multiple times (they are invoked if an initializer activity has completed, and every time the pre-condition transitions from false to true).
    • automatic - True if it's an automatic ad-hoc activity; false if it's a manual ad-hoc activity.
    • completedCount - The number of times the ad-hoc activity has been invoked and completed.
Required System Action
None
API Descriptions