Interface for z/OSMF API response.

export
interface

  IPromptVariable

### Hierarchy

- IPromptVariable

## Index

### Properties

- abstract
- choices
- description
- error-message
- label
- max
- min
- multi-line
- must-be-choice
- name
- places
- regex
- required
- type
- value

## Properties

### abstract

abstract: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:61

Brief description of the variable for the UI widget.

memberof

  IPromptVariable

### choices

choices: string[]

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:82

Contains allowable choices for the value of the variable.

memberof

  IPromptVariable

### description

description: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:54

Explanation of what the variable is used for and perhaps what the syntactic requirements are.

memberof

  IPromptVariable

### error-message

error-message: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:126

Default error message associated with an incorrect value.

memberof

  IPromptVariable

### label

label: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:47

Short label for the UI widget.

memberof

  IPromptVariable

### max

max: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:112

For a string type, indicates the maximum string length of the value. For all other types, indicates the maximum value required.

memberof

  IPromptVariable

### min

min: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:104

For a string type, indicates the minimum string length of the value. For all other types, indicates the minimum value required.

memberof

  IPromptVariable

### multi-line

multi-line: boolean

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:96

Indicates whether the value requires a multi-line text box.

memberof

  IPromptVariable

### must-be-choice

must-be-choice: boolean

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:75

Indicates whether the value must come from the provided choices.

memberof

  IPromptVariable

### name

name: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:26

Name of the property.

memberof

  IPromptVariable

### places

places: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:119

Maximum number of decimal places that can be specified for a variable of the decimal type.

memberof

  IPromptVariable

### regex

regex: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:89

Standard regular expression that constrains the variable value.

memberof

  IPromptVariable

### required

required: boolean

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:40

Indicates whether the variable value is required during the workflow create process.

memberof

  IPromptVariable

### type

type: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:68

Type of variable element: boolean, string, integer, decimal, time, date.

memberof

  IPromptVariable

### value

value: string

- Defined in @zowe/provisioning-for-zowe-sdk/src/doc/zosmf/IPromptVariable.ts:33

Current value for the property.

memberof

  IPromptVariable

Generated using TypeDoc