Skip to content

/AWS1/CL_BDZAPIRESULT

Contains information about the API operation that was called from the action group and the response body that was returned.

This data type is used in the following API operations:

CONSTRUCTOR

IMPORTING

Required arguments:

iv_actiongroup TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The action group that the API operation belongs to.

Optional arguments:

iv_httpmethod TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The HTTP method for the API operation.

iv_apipath TYPE /AWS1/BDZAPIPATH /AWS1/BDZAPIPATH

The path to the API operation.

iv_confirmationstate TYPE /AWS1/BDZCONFIRMATIONSTATE /AWS1/BDZCONFIRMATIONSTATE

Controls the API operations or functions to invoke based on the user confirmation.

iv_responsestate TYPE /AWS1/BDZRESPONSESTATE /AWS1/BDZRESPONSESTATE

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

iv_httpstatuscode TYPE /AWS1/BDZINTEGER /AWS1/BDZINTEGER

http status code from API execution response (for example: 200, 400, 500).

it_responsebody TYPE /AWS1/CL_BDZCONTENTBODY=>TT_RESPONSEBODY TT_RESPONSEBODY

The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

iv_agentid TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The agent's ID.

Queryable Attributes

actionGroup

The action group that the API operation belongs to.

Accessible with the following methods

Method Description
GET_ACTIONGROUP() Getter for ACTIONGROUP, with configurable default
ASK_ACTIONGROUP() Getter for ACTIONGROUP w/ exceptions if field has no value
HAS_ACTIONGROUP() Determine if ACTIONGROUP has a value

httpMethod

The HTTP method for the API operation.

Accessible with the following methods

Method Description
GET_HTTPMETHOD() Getter for HTTPMETHOD, with configurable default
ASK_HTTPMETHOD() Getter for HTTPMETHOD w/ exceptions if field has no value
HAS_HTTPMETHOD() Determine if HTTPMETHOD has a value

apiPath

The path to the API operation.

Accessible with the following methods

Method Description
GET_APIPATH() Getter for APIPATH, with configurable default
ASK_APIPATH() Getter for APIPATH w/ exceptions if field has no value
HAS_APIPATH() Determine if APIPATH has a value

confirmationState

Controls the API operations or functions to invoke based on the user confirmation.

Accessible with the following methods

Method Description
GET_CONFIRMATIONSTATE() Getter for CONFIRMATIONSTATE, with configurable default
ASK_CONFIRMATIONSTATE() Getter for CONFIRMATIONSTATE w/ exceptions if field has no v
HAS_CONFIRMATIONSTATE() Determine if CONFIRMATIONSTATE has a value

responseState

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

Accessible with the following methods

Method Description
GET_RESPONSESTATE() Getter for RESPONSESTATE, with configurable default
ASK_RESPONSESTATE() Getter for RESPONSESTATE w/ exceptions if field has no value
HAS_RESPONSESTATE() Determine if RESPONSESTATE has a value

httpStatusCode

http status code from API execution response (for example: 200, 400, 500).

Accessible with the following methods

Method Description
GET_HTTPSTATUSCODE() Getter for HTTPSTATUSCODE, with configurable default
ASK_HTTPSTATUSCODE() Getter for HTTPSTATUSCODE w/ exceptions if field has no valu
HAS_HTTPSTATUSCODE() Determine if HTTPSTATUSCODE has a value

responseBody

The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

Accessible with the following methods

Method Description
GET_RESPONSEBODY() Getter for RESPONSEBODY, with configurable default
ASK_RESPONSEBODY() Getter for RESPONSEBODY w/ exceptions if field has no value
HAS_RESPONSEBODY() Determine if RESPONSEBODY has a value

agentId

The agent's ID.

Accessible with the following methods

Method Description
GET_AGENTID() Getter for AGENTID, with configurable default
ASK_AGENTID() Getter for AGENTID w/ exceptions if field has no value
HAS_AGENTID() Determine if AGENTID has a value