Class CancelWorkflow

Class to handle canceling of zOSMF workflow instance

Hierarchy

CancelWorkflow

Index

Methods

cancelWorkflow

Methods

Static cancelWorkflow

cancelWorkflow(session: AbstractSession, workflowKey: string, zOSMFVersion?: string): Promise<any>

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/Cancel.ts:31
Cancel a workflow instance

memberof

CancelWorkflow

Parameters
- session: AbstractSession
  
  z/OSMF connection info
- workflowKey: string
  
  Unique identifier of the workflow instance.
- Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
  
  Identifies the version of the zOSMF workflow service.
Returns Promise<any>
- Promise that specifies the new name of the canceled workflow.

Generated using TypeDoc