Interface for the step summary

export
interface

  IStepSummary

### Hierarchy

- IStepInfo
  - IStepSummary

## Index

### Properties

- actualStatusCode
- assignees
- autoEnable
- calledInstanceKey
- calledInstanceScope
- calledInstanceURI
- calledWorkflowDefinitionFile
- calledWorkflowDescription
- calledWorkflowID
- calledWorkflowMD5
- calledWorkflowVersion
- description
- expectedStatusCode
- failedPattern
- hasCalledWorkflow
- hostname
- httpMethod
- instructions
- instructionsSub
- isConditionStep
- isRestStep
- jobInfo
- maxLrecl
- misc
- name
- optional
- output
- outputSub
- outputVariablesPrefix
- owner
- port
- portSub
- prereqStep
- procName
- queryParameters
- queryParametersSub
- regionSize
- requestBody
- requestBodySub
- returnCode
- runAsUser
- runAsUserDynamic
- saveAsDataset
- saveAsDatasetSub
- saveAsUnixFile
- saveAsUnixFileSub
- schemeName
- schemeNameSub
- scriptParameters
- skills
- state
- stepNumber
- steps
- submitAs
- successPattern
- template
- templateSub
- timeout
- title
- uriPath
- uriPathSub
- userDefined
- variable-references
- weight

## Properties

### Optional actualStatusCode

actualStatusCode: string

Inherited from IStepInfo.actualStatusCode

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

HTTP status code.

memberof

  IStepInfo

### Optional assignees

assignees: string

Inherited from IStepInfo.assignees

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:41

Step assignees.

memberof

  IStepInfo

### autoEnable

autoEnable: boolean

Inherited from IStepInfo.autoEnable

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:48

Indicates whether the step can be performed automatically.

memberof

  IStepInfo

### Optional calledInstanceKey

calledInstanceKey: string

Inherited from IStepInfo.calledInstanceKey

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:55

Key of the called workflow instance.

memberof

  IStepInfo

### Optional calledInstanceScope

calledInstanceScope: string

Inherited from IStepInfo.calledInstanceScope

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:62

Scope of the called workflow instance.

memberof

  IStepInfo

### Optional calledInstanceURI

calledInstanceURI: string

Inherited from IStepInfo.calledInstanceURI

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

URI path of the called workflow instance.

memberof

  IStepInfo

### Optional calledWorkflowDefinitionFile

calledWorkflowDefinitionFile: string

Inherited from IStepInfo.calledWorkflowDefinitionFile

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:104

Workflow definition file that is used to create a new workflow.

memberof

  IStepInfo

### Optional calledWorkflowDescription

calledWorkflowDescription: string

Inherited from IStepInfo.calledWorkflowDescription

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:97

Describes the workflow to be called.

memberof

  IStepInfo

### Optional calledWorkflowID

calledWorkflowID: string

Inherited from IStepInfo.calledWorkflowID

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:76

Workflow ID of a workflow definition file.

memberof

  IStepInfo

### Optional calledWorkflowMD5

calledWorkflowMD5: string

Inherited from IStepInfo.calledWorkflowMD5

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:90

128-bit hash value of a workflow definition file.

memberof

  IStepInfo

### Optional calledWorkflowVersion

calledWorkflowVersion: string

Inherited from IStepInfo.calledWorkflowVersion

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:83

Version of a workflow definition file.

memberof

  IStepInfo

### description

description: string

Inherited from IStepInfo.description

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:111

Step description.

memberof

  IStepInfo

### Optional expectedStatusCode

expectedStatusCode: string

Inherited from IStepInfo.expectedStatusCode

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:118

HTTP status code from the REST API request.

memberof

  IStepInfo

### Optional failedPattern

failedPattern: string[]

Inherited from IStepInfo.failedPattern

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:125

Optional regular expression for program execution failures.

memberof

  IStepInfo

### Optional hasCalledWorkflow

hasCalledWorkflow: boolean

Inherited from IStepInfo.hasCalledWorkflow

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:132

Indicates whether this step calls another workflow.

memberof

  IStepInfo

### Optional hostname

hostname: string

Inherited from IStepInfo.hostname

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:139

Indicates the hostname or IP address.

memberof

  IStepInfo

### Optional httpMethod

httpMethod: string

Inherited from IStepInfo.httpMethod

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:146

HTTP method that is used for issuing the REST API request.

memberof

  IStepInfo

### Optional instructions

instructions: string

Inherited from IStepInfo.instructions

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:153

Instructions on what the user must do to perform the step.

memberof

  IStepInfo

### Optional instructionsSub

instructionsSub: boolean

Inherited from IStepInfo.instructionsSub

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:160

Indicates whether the step instructions contain variables.

memberof

  IStepInfo

### Optional isConditionStep

isConditionStep: boolean

Inherited from IStepInfo.isConditionStep

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:167

Indicates whether this step is a conditional step.

memberof

  IStepInfo

### isRestStep

isRestStep: boolean

Inherited from IStepInfo.isRestStep

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:174

Indicates whether this step is a REST API step.

memberof

  IStepInfo

### Optional jobInfo

jobInfo: IJobInfo

Inherited from IStepInfo.jobInfo

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:181

Contains the jobInfo object, which contains details about the job.

memberof

  IStepInfo

### Optional maxLrecl

maxLrecl: number

Inherited from IStepInfo.maxLrecl

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:188

Specifies the maximum record length for a job.

memberof

  IStepInfo

### Optional misc

misc: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepSummary.ts:49

Depends on the type of the step. It can contain JOBID, REST response, etc

memberof

  IStepSummary

### name

name: string

Overrides IStepInfo.name

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

Step name

memberof

  IStepSummary

### optional

optional: boolean

Inherited from IStepInfo.optional

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:195

Indicates whether the step is optional.

memberof

  IStepInfo

### Optional output

output: string

Inherited from IStepInfo.output

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:202

Name of the output file that is produced by the step.

memberof

  IStepInfo

### Optional outputSub

outputSub: boolean

Inherited from IStepInfo.outputSub

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:209

Indicates whether the output file name contains variable substitution.

memberof

  IStepInfo

### Optional outputVariablesPrefix

outputVariablesPrefix: string

Inherited from IStepInfo.outputVariablesPrefix

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

Contains a prefix that identifies a string as a variable.

memberof

  IStepInfo

### Optional owner

owner: string

Inherited from IStepInfo.owner

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:223

User ID of the step owner.

memberof

  IStepInfo

### Optional port

port: string

Inherited from IStepInfo.port

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:230

Port number that is associated with the REST request.

memberof

  IStepInfo

### Optional portSub

portSub: boolean

Inherited from IStepInfo.portSub

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

Indicates whether the port number contains variable substitution.

memberof

  IStepInfo

### Optional prereqStep

prereqStep: string[]

Inherited from IStepInfo.prereqStep

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:244

Lists the names of the steps that must be completed before this step.

memberof

  IStepInfo

### Optional procName

procName: string

Inherited from IStepInfo.procName

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:251

Name of the logon procedure that is used to log into the TSO/E.

memberof

  IStepInfo

### Optional queryParameters

queryParameters: string

Inherited from IStepInfo.queryParameters

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:258

Contains the query parameters.

memberof

  IStepInfo

### Optional queryParametersSub

queryParametersSub: boolean

Inherited from IStepInfo.queryParametersSub

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

Indicates whether the query parameters contain variable substitution.

memberof

  IStepInfo

### Optional regionSize

regionSize: string

Inherited from IStepInfo.regionSize

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:272

Contains the region size for the TSO/E address space.

memberof

  IStepInfo

### Optional requestBody

requestBody: string

Inherited from IStepInfo.requestBody

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:279

Contains the request body.

memberof

  IStepInfo

### Optional requestBodySub

requestBodySub: boolean

Inherited from IStepInfo.requestBodySub

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

Indicates whether the request body variable substitution.

memberof

  IStepInfo

### Optional returnCode

returnCode: string

Inherited from IStepInfo.returnCode

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:293

Indicates the return code that was returned when the job was submitted.

memberof

  IStepInfo

### runAsUser

runAsUser: string

Inherited from IStepInfo.runAsUser

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:300

The user ID under which the step is to be performed.

memberof

  IStepInfo

### Optional runAsUserDynamic

runAsUserDynamic: boolean

Inherited from IStepInfo.runAsUserDynamic

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:307

Indicates whether the runAsUser ID value can change.

memberof

  IStepInfo

### Optional saveAsDataset

saveAsDataset: string

Inherited from IStepInfo.saveAsDataset

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:314

Data set name that contains the saved JCL.

memberof

  IStepInfo

### Optional saveAsDatasetSub

saveAsDatasetSub: boolean

Inherited from IStepInfo.saveAsDatasetSub

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:321

Indicates whether the data set name contains variable substitution.

memberof

  IStepInfo

### Optional saveAsUnixFile

saveAsUnixFile: string

Inherited from IStepInfo.saveAsUnixFile

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:328

UNIX file name (absolute name) that contains the saved JCL.

memberof

  IStepInfo

### Optional saveAsUnixFileSub

saveAsUnixFileSub: boolean

Inherited from IStepInfo.saveAsUnixFileSub

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:335

Indicates whether the UNIX file name contains variable substitution.

memberof

  IStepInfo

### Optional schemeName

schemeName: string

Inherited from IStepInfo.schemeName

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:342

Name that is used for the REST request.

memberof

  IStepInfo

### Optional schemeNameSub

schemeNameSub: boolean

Inherited from IStepInfo.schemeNameSub

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:349

Indicates whether the scheme name contains variable substitution.

memberof

  IStepInfo

### Optional scriptParameters

scriptParameters: string[]

Inherited from IStepInfo.scriptParameters

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:356

Contains the input parameters that can be set by the step owner.

memberof

  IStepInfo

### Optional skills

skills: string

Inherited from IStepInfo.skills

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:363

Type of skills that are required to perform the step.

memberof

  IStepInfo

### state

state: string

Overrides IStepInfo.state

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepSummary.ts:41

State of the step

memberof

  IStepSummary

### stepNumber

stepNumber: string

Overrides IStepInfo.stepNumber

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepSummary.ts:27

ID of the step

memberof

  IStepSummary

### Optional steps

steps: IStepInfo[]

Inherited from IStepInfo.steps

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:384

For a parent step, this is a nested array of step-info objects.

memberof

  IStepInfo

### Optional submitAs

submitAs: string

Inherited from IStepInfo.submitAs

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:391

Indicates the type of executable program.

memberof

  IStepInfo

### Optional successPattern

successPattern: string

Inherited from IStepInfo.successPattern

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:398

Regular expression that is returned for a successful program execution.

memberof

  IStepInfo

### Optional template

template: string

Inherited from IStepInfo.template

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:405

Indicates the template that is used to run a program or batch job.

memberof

  IStepInfo

### Optional templateSub

templateSub: boolean

Inherited from IStepInfo.templateSub

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:412

Indicates whether template contains variable substitution.

memberof

  IStepInfo

### Optional timeout

timeout: string

Inherited from IStepInfo.timeout

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:419

contains the maximum amount of time that the program can run.

memberof

  IStepInfo

### title

title: string

Inherited from IStepInfo.title

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:426

Step title.

memberof

  IStepInfo

### Optional uriPath

uriPath: string

Inherited from IStepInfo.uriPath

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:433

The URI path to use for the REST request.

memberof

  IStepInfo

### Optional uriPathSub

uriPathSub: boolean

Inherited from IStepInfo.uriPathSub

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:440

Indicates whether the URI path contains variable substitution.

memberof

  IStepInfo

### userDefined

userDefined: boolean

Inherited from IStepInfo.userDefined

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:447

Indicates whether the step was added manually to the workflow.

memberof

  IStepInfo

### Optional variable-references

variable-references: IVariable[]

Inherited from IStepInfo.variable-references

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:454

An array of variable-reference objects.

memberof

  IStepInfo

### Optional weight

weight: number

Inherited from IStepInfo.weight

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepInfo.ts:461

The relative difficulty of the step compared to other steps.

memberof

  IStepInfo

Generated using TypeDoc