Class ListWorkflows

Get list of workflows from registry.

export

Hierarchy

ListWorkflows

Index

Methods

Methods

Static getResourceQuery

getResourceQuery(params: IGetWorkflowsOptions): string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/ListWorkflows.ts:53
This operation Builds URI path from provided parameters.

memberof

ListWorkflows

Parameters
- params: IGetWorkflowsOptions
  
  The array with URI path with filters for listing filtered workflows.
Returns string

URI path for the REST call.

Static getWfKey

getWfKey(session: AbstractSession, workflowName: string, zOSMFVersion?: string): Promise<string> | null

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/ListWorkflows.ts:77
This operation is used to return a worflow-key by given workflow name.

throws

{ImperativeError}

memberof

ListWorkflows

Parameters
- session: AbstractSession
  
  z/OSMF connection info
- workflowName: string
  
  workflow name by which to list workflows
- Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
  
  identifies the version of the provisioning service.
Returns Promise<string> | null
- Promise with string containing wf key, or null if none was found

Static getWorkflows

getWorkflows(session: AbstractSession, options?: IGetWorkflowsOptions): Promise<any>

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/ListWorkflows.ts:33
This operation returns list of workflows. Parameters are optional,request can include one or more parameters to filter the results.

memberof

ListWorkflows

Parameters
- session: AbstractSession
  
  z/OSMF connection info
- Default value options: IGetWorkflowsOptions = {}
  
  Options to filter the request
Returns Promise<any>

z/OSMF response object

Generated using TypeDoc