Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListWorkflows

Get list of workflows from registry.

export

Hierarchy

  • ListWorkflows

Index

Methods

Methods

Static getResourceQuery

Static getResourcesQuery

  • getResourcesQuery(zOSMFVersion: string, params: Array<{ key: string; value: string }>): string

  • This operation Builds URI path from provided parameters.

    memberof

    ListWorkflows

    deprecated

    Parameters

    • zOSMFVersion: string

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

    • params: Array<{ key: string; value: string }>

      The array with URI path with filters for listing filtered workflows.

    Returns string

    URI path for the REST call.

Static getWfKey

  • 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

Static listWorkflows

  • listWorkflows(session: AbstractSession, zOSMFVersion?: string, workflowName?: string, category?: string, system?: string, owner?: string, vendor?: string, statusName?: string): Promise<any>

  • This operation returns list of workflows. Parameters are optional,request can include one or more parameters to filter the results.

    memberof

    ListWorkflows

    deprecated

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION

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

    • Optional workflowName: string

      the URI path with optional parameter for listing filtered workflows.

    • Optional category: string

      the URI path with optional parameter for listing filtered workflows.

    • Optional system: string

      the URI path with optional parameter for listing filtered workflows.

    • Optional owner: string

      the URI path with optional parameter for listing filtered workflows.

    • Optional vendor: string

      the URI path with optional parameter for listing filtered workflows.

    • Optional statusName: string

      the URI path with optional parameter for listing filtered workflows.

    Returns Promise<any>

    z/OSMF response object

Generated using TypeDoc