Interface for z/OSMF API response.

export
interface

  IStepDefinition

### Hierarchy

- IStepDefinition

## Index

### Properties

- actualStatusCode
- approvers
- autoEnable
- calledWorkflowDefinitionFile
- calledWorkflowDescription
- calledWorkflowID
- calledWorkflowMD5
- calledWorkflowVersion
- callingStepAutoEnable
- callingStepSkills
- callingStepWeight
- description
- expectedStatusCode
- failedPattern
- hostname
- httpMethod
- instructions
- instructionsSub
- isConditionStep
- isRestStep
- maxLrecl
- name
- optional
- output
- outputSub
- outputVariablesPrefix
- port
- portSub
- prereqStep
- procName
- propertyMappings
- queryParameters
- queryParametersSub
- regionSize
- requestBody
- requestBodySub
- saveAsDataset
- saveAsDatasetSub
- saveAsUnixFile
- saveAsUnixFileSub
- schemeName
- schemeNameSub
- scriptParameters
- skills
- steps
- submitAs
- successPattern
- template
- templateSub
- timeout
- title
- uriPath
- uriPathSub
- variable-specifications
- weight

## Properties

### Optional actualStatusCode

actualStatusCode: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:129

HTTP status code.

memberof

  IStepDefinition

### Optional approvers

approvers: IStepApprovers[]

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:136

Step approvers.

memberof

  IStepDefinition

### Optional autoEnable

autoEnable: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:143

Indicates whether the step can be performed automatically.

memberof

  IStepDefinition

### Optional calledWorkflowDefinitionFile

calledWorkflowDefinitionFile: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:93

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

memberof

  IStepDefinition

### Optional calledWorkflowDescription

calledWorkflowDescription: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:72

Describes the workflow to be called.

memberof

  IStepDefinition

### Optional calledWorkflowID

calledWorkflowID: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:79

Workflow ID of a workflow definition file.

memberof

  IStepDefinition

### Optional calledWorkflowMD5

calledWorkflowMD5: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:86

128-bit hash value of a workflow definition file.

memberof

  IStepDefinition

### Optional calledWorkflowVersion

calledWorkflowVersion: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:100

Version of a workflow definition file.

memberof

  IStepDefinition

### Optional callingStepAutoEnable

callingStepAutoEnable: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:107

Indicates whether step can be performed auto.

memberof

  IStepDefinition

### Optional callingStepSkills

callingStepSkills: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:121

Indicates type of skill to execute the step.

memberof

  IStepDefinition

### Optional callingStepWeight

callingStepWeight: number

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:114

Indicates relative dificulty of the step.

memberof

  IStepDefinition

### description

description: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:43

Step description.

memberof

  IStepDefinition

### Optional expectedStatusCode

expectedStatusCode: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:150

HTTP status code from the REST API request.

memberof

  IStepDefinition

### Optional failedPattern

failedPattern: string[]

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:157

Optional regular expression for program execution failures.

memberof

  IStepDefinition

### Optional hostname

hostname: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:164

Indicates the hostname or IP address.

memberof

  IStepDefinition

### Optional httpMethod

httpMethod: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:171

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

memberof

  IStepDefinition

### Optional instructions

instructions: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:178

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

memberof

  IStepDefinition

### Optional instructionsSub

instructionsSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:185

Indicates whether the step instructions contain variables.

memberof

  IStepDefinition

### Optional isConditionStep

isConditionStep: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:192

Indicates whether this step is a conditional step.

memberof

  IStepDefinition

### Optional isRestStep

isRestStep: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:199

Indicates whether this step is a REST API step.

memberof

  IStepDefinition

### Optional maxLrecl

maxLrecl: number

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

Specifies the maximum record length for a job.

memberof

  IStepDefinition

### name

name: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:29

Name of the step.

memberof

  IStepDefinition

### optional

optional: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:57

Indicates whether the step is optional.

memberof

  IStepDefinition

### Optional output

output: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:213

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

memberof

  IStepDefinition

### Optional outputSub

outputSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:220

Indicates whether the output file name contains variable substitution.

memberof

  IStepDefinition

### Optional outputVariablesPrefix

outputVariablesPrefix: string

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

Contains a prefix that identifies a string as a variable.

memberof

  IStepDefinition

### Optional port

port: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:234

Port number that is associated with the REST request.

memberof

  IStepDefinition

### Optional portSub

portSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:241

Indicates whether the port number contains variable substitution.

memberof

  IStepDefinition

### Optional prereqStep

prereqStep: string[]

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:50

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

memberof

  IStepDefinition

### Optional procName

procName: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:248

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

memberof

  IStepDefinition

### Optional propertyMappings

propertyMappings: IPropertyMapping[]

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

Array of property mapping.

memberof

  IStepDefinition

### Optional queryParameters

queryParameters: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:262

Contains the query parameters.

memberof

  IStepDefinition

### Optional queryParametersSub

queryParametersSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:269

Indicates whether the query parameters contain variable substitution.

memberof

  IStepDefinition

### Optional regionSize

regionSize: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:276

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

memberof

  IStepDefinition

### Optional requestBody

requestBody: string

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

Contains the request body.

memberof

  IStepDefinition

### Optional requestBodySub

requestBodySub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:290

Indicates whether the request body variable substitution.

memberof

  IStepDefinition

### Optional saveAsDataset

saveAsDataset: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:297

Data set name that contains the saved JCL.

memberof

  IStepDefinition

### Optional saveAsDatasetSub

saveAsDatasetSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:304

Indicates whether the data set name contains variable substitution.

memberof

  IStepDefinition

### Optional saveAsUnixFile

saveAsUnixFile: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:311

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

memberof

  IStepDefinition

### Optional saveAsUnixFileSub

saveAsUnixFileSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:318

Indicates whether the UNIX file name contains variable substitution.

memberof

  IStepDefinition

### Optional schemeName

schemeName: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:325

Name that is used for the REST request.

memberof

  IStepDefinition

### Optional schemeNameSub

schemeNameSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:332

Indicates whether the scheme name contains variable substitution.

memberof

  IStepDefinition

### Optional scriptParameters

scriptParameters: string[]

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:339

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

memberof

  IStepDefinition

### Optional skills

skills: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:346

Type of skills that are required to perform the step.

memberof

  IStepDefinition

### Optional steps

steps: IStepDefinition[]

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:64

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

memberof

  IStepDefinition

### Optional submitAs

submitAs: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:353

Indicates the type of executable program.

memberof

  IStepDefinition

### Optional successPattern

successPattern: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:360

Regular expression that is returned for a successful program execution.

memberof

  IStepDefinition

### Optional template

template: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:367

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

memberof

  IStepDefinition

### Optional templateSub

templateSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:374

Indicates whether template contains variable substitution.

memberof

  IStepDefinition

### Optional timeout

timeout: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:381

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

memberof

  IStepDefinition

### title

title: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:36

Step title.

memberof

  IStepDefinition

### Optional uriPath

uriPath: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:388

The URI path to use for the REST request.

memberof

  IStepDefinition

### Optional uriPathSub

uriPathSub: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:395

Indicates whether the URI path contains variable substitution.

memberof

  IStepDefinition

### Optional variable-specifications

variable-specifications: IVariableSpecification[]

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:402

An array of variable-reference objects.

memberof

  IStepDefinition

### Optional weight

weight: number

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IStepDefinition.ts:409

The relative difficulty of the step compared to other steps.

memberof

  IStepDefinition

Generated using TypeDoc