# z/OS Workflows Package

Contains APIs to interact with the z/OS workflows APIs

## API Examples

List Active Workflow Instance(s) in z/OSMF

    import { ProfileInfo } from "@zowe/imperative";
    import { IActiveWorkflows, ListWorkflows } from "@zowe/zos-workflows-for-zowe-sdk";

    (async () => {
        // Load connection info from default z/OSMF profile
        const profInfo = new ProfileInfo("zowe");
        await profInfo.readProfilesFromDisk();
        const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
        const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
        const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);

        const response: IActiveWorkflows = await ListWorkflows.getWorkflows(session);
        console.log(response.workflows);
    })().catch((err) => {
        console.error(err);
        process.exit(1);
    });

## Index

### Classes

- ArchiveWorkflow
- ArchivedDeleteWorkflow
- CancelWorkflow
- CreateWorkflow
- DefinitionWorkflow
- DeleteWorkflow
- ListArchivedWorkflows
- ListWorkflows
- PropertiesWorkflow
- StartWorkflow
- WorkflowConstants
- WorkflowValidator

### Interfaces

- IActiveWorkflows
- IArchivedWorkflow
- IArchivedWorkflows
- IAutomationStatus
- ICreateWorkflow
- ICreatedWorkflow
- ICreatedWorkflowLocal
- IGetWorkflowsOptions
- IJobFiles
- IJobInfo
- IJobStatus
- IPropertyMapping
- IStartWorkflow
- IStepApprovers
- IStepDefinition
- IStepInfo
- IStepSummary
- IVariable
- IVariableDefinition
- IVariableInfo
- IVariableSpecification
- IWorkflowDefinition
- IWorkflowInfo
- IWorkflows
- IWorkflowsInfo

### Type aliases

- accessT
- startT

### Object literals

- WrongWorkflowKey
- noOwner
- noSteps
- noSystemName
- noVariables
- noWorkflowDefinitionFile
- noWorkflowKey
- noWorkflowName
- wrongOwner
- wrongString

## Type aliases

### accessT

accessT: "Public" | "Private" | "Restricted"

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/ICreateWorkflow.ts:14

### startT

startT: "outputFileValue" | "existingValue" | "leaveConflict"

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStartWorkflow.ts:12

## Object literals

### Const WrongWorkflowKey

WrongWorkflowKey: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:216

Error message that workflow key that was supplied does not exist. IZUWF5001W: The workflow key "workflowkey" was not found.

static
memberof

  WorkflowConstants

### message

message: string = "IZUWF5001W"

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:217

### Const noOwner

noOwner: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:283

Error message that no owner parameter string was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` No owner parameter was supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:284

### Const noSteps

noSteps: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:226

Error message that no steps parameter was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` No steps parameter was supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:227

### Const noSystemName

noSystemName: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:264

Error message that no system name parameter string was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` No system name parameter was supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:265

### Const noVariables

noVariables: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:236

Error message that no variables parameter was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` No variables parameter was supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:237

### Const noWorkflowDefinitionFile

noWorkflowDefinitionFile: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:246

Error message that no workflow definition file parameter string was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` No workflow definition file parameter was supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:247

### Const noWorkflowKey

noWorkflowKey: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:205

Error message that no workflow key string was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` No workflow key parameter was supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:206

### Const noWorkflowName

noWorkflowName: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:255

Error message that no workflow name parameter string was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` No workflow name parameter was supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:256

### Const wrongOwner

wrongOwner: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:286

### message

message: string = apiErrorHeader.message + ` Wrong format of user ID supplied.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:287

### Const wrongString

wrongString: object

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:274

Error message that no system name parameter string was supplied.

static
memberof

  WorkflowConstants

### message

message: string = apiErrorHeader.message + ` Parameter contains wrong character - & or ?.`

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/WorkflowConstants.ts:275

Generated using TypeDoc