### Hierarchy

- PropertiesWorkflow

## Index

### Methods

- getWorkflowProperties
- processStepSummaries

## Methods

### Static getWorkflowProperties

- getWorkflowProperties(session: AbstractSession, workflowKey: string, zOSMFVersion?: string, steps?: boolean, variables?: boolean): Promise<IWorkflowInfo>

- - Defined in @zowe/zos-workflows-for-zowe-sdk/src/Properties.ts:34

  This operation returns properties of the workflow. Parameters indicators are mandatory,request can include steps and variables indicator for requested result.

  memberof

    Properties

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### workflowKey: string

  - ##### Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION

    the URI path that identifies the version of the provisioning service.

  - ##### Optional steps: boolean

    Optional parameter for listing steps properties.

  - ##### Optional variables: boolean

    Optional parameter for listing variables properties.

  #### Returns Promise<IWorkflowInfo>

  z/OSMF response object

### Static Protected processStepSummaries

- processStepSummaries(steps: IStepInfo[]): Promise<IStepSummary[]>

- - Defined in @zowe/zos-workflows-for-zowe-sdk/src/Properties.ts:69

  Processes the z/OSMF workflow step info in a recursive manner.

  static
  memberof

    PropertiesWorkflow

  #### Parameters

  - ##### steps: IStepInfo[]

    z/OSMF steps to be processed

  #### Returns Promise<IStepSummary[]>

  Array of z/OSMF step summary objects

Generated using TypeDoc