releaseEvent(eventID)
Use this method to release an event that was held.
Releasing an event that was held (status of suspended) queues the event for execution and changes the status to pending.
For more information about event status, see the bibus » runStatusEnum enumeration set and Running Jobs.
Use of this method requires:
traverse permission for all ancestors of the target object associated with the event
one of the following conditions to be met:
The caller has the canUseMonitorActivityTool capability.
This allows administrators to release tasks initiated by other users.
The passport ID of the caller must match the account associated with the task.
This allows users to release their own tasks that are running in the background.
The account of the caller must match the account credential used to schedule the task.
This allows users to release tasks that they previously scheduled.
Signatures
- Java and Apache Axis
public void releaseEvent(java.lang.String eventID)
- C# .NET
public void releaseEvent(string eventID)
References
- Part of the following method sets:
- Implemented by the following services:
The services that implement the releaseEvent method, along with the associated SOAP actions, are listed in the following table.
Table 1. Services implementing the releaseEvent method. Service
SOAP Action
eventManagementService
http://www.ibm.com/xmlns/prod/cognos/eventManagementService/201404/
What's new
- New in Version 10.1.0 — Administration Capabilities for Background Job Queue Maintenance
This method now requires the caller to have the canUseMonitorActivityTool value capability instead of the canUseAdministrationPortal value capability when a capability check is required.
Related information:
- event » releaseEvents(eventIDs) method
Input parameters
Use the following parameters when calling this method.
- eventID
Identifies the event.
This argument
is of type
string
is encoded as type
xs:string
Return values
None.