The Console API response.

export
interface

  IConsoleResponse

### Hierarchy

- IConsoleResponse

## Index

### Properties

- cmdResponseUrl
- commandResponse
- failureResponse
- keywordDetected
- lastResponseKey
- success
- zosmfResponse

## Properties

### Optional cmdResponseUrl

cmdResponseUrl: string

- Defined in @zowe/zos-console-for-zowe-sdk/src/doc/IConsoleResponse.ts:70

The "follow-up" command response URL - you can paste this in the browser to do a "GET" using the command response key provided in the URI route.

memberof

  IConsoleResponse

### commandResponse

commandResponse: string

- Defined in @zowe/zos-console-for-zowe-sdk/src/doc/IConsoleResponse.ts:48

The command response text.

type{string}
memberof

  IConsoleResponse

### Optional failureResponse

failureResponse: ImperativeError

- Defined in @zowe/zos-console-for-zowe-sdk/src/doc/IConsoleResponse.ts:41

If an error occurs, returns the ImperativeError, which contains casue error.

memberof

  IConsoleResponse

### Optional keywordDetected

keywordDetected: boolean

- Defined in @zowe/zos-console-for-zowe-sdk/src/doc/IConsoleResponse.ts:62

If the solicited keyword is specified, indicates that the keyword was detected.

memberof

  IConsoleResponse

### Optional lastResponseKey

lastResponseKey: string

- Defined in @zowe/zos-console-for-zowe-sdk/src/doc/IConsoleResponse.ts:55

The final command response key - used to "follow-up" and check for additional response messages for the command.

memberof

  IConsoleResponse

### success

success: boolean

- Defined in @zowe/zos-console-for-zowe-sdk/src/doc/IConsoleResponse.ts:26

True if the command was issued and the responses were collected.

memberof

  IConsoleResponse

### zosmfResponse

zosmfResponse: IZosmfIssueResponse[]

- Defined in @zowe/zos-console-for-zowe-sdk/src/doc/IConsoleResponse.ts:34

The list of zOSMF console API responses. May issue multiple requests (because of user request) or to ensure that all messages are collected. Each individual response is placed here.

memberof

  IConsoleResponse

Generated using TypeDoc