/AWS1/CL_BDZAPIINVOCATIONINPUT

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

• In the returnControl field of the InvokeAgent response

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 of the API operation.

iv_apipath TYPE /AWS1/BDZAPIPATH /AWS1/BDZAPIPATH

The path to the API operation.

it_parameters TYPE /AWS1/CL_BDZAPIPARAMETER=>TT_APIPARAMETERS TT_APIPARAMETERS

The parameters to provide for the API request, as the agent elicited from the user.

io_requestbody TYPE REF TO /AWS1/CL_BDZAPIREQUESTBODY /AWS1/CL_BDZAPIREQUESTBODY

The request body to provide for the API request, as the agent elicited from the user.

iv_actioninvocationtype TYPE /AWS1/BDZACTIONINVOCATIONTYPE /AWS1/BDZACTIONINVOCATIONTYPE

Contains information about the API operation to invoke.

iv_agentid TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The agent's ID.

iv_collaboratorname TYPE /AWS1/BDZNAME /AWS1/BDZNAME

The agent collaborator's name.

---

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 of 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

parameters

The parameters to provide for the API request, as the agent elicited from the user.

Accessible with the following methods

Method	Description
GET_PARAMETERS()	Getter for PARAMETERS, with configurable default
ASK_PARAMETERS()	Getter for PARAMETERS w/ exceptions if field has no value
HAS_PARAMETERS()	Determine if PARAMETERS has a value

requestBody

The request body to provide for the API request, as the agent elicited from the user.

Accessible with the following methods

Method	Description
GET_REQUESTBODY()	Getter for REQUESTBODY

actionInvocationType

Contains information about the API operation to invoke.

Accessible with the following methods

Method	Description
GET_ACTIONINVOCATIONTYPE()	Getter for ACTIONINVOCATIONTYPE, with configurable default
ASK_ACTIONINVOCATIONTYPE()	Getter for ACTIONINVOCATIONTYPE w/ exceptions if field has n
HAS_ACTIONINVOCATIONTYPE()	Determine if ACTIONINVOCATIONTYPE 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

collaboratorName

The agent collaborator's name.

Accessible with the following methods

Method	Description
GET_COLLABORATORNAME()	Getter for COLLABORATORNAME, with configurable default
ASK_COLLABORATORNAME()	Getter for COLLABORATORNAME w/ exceptions if field has no va
HAS_COLLABORATORNAME()	Determine if COLLABORATORNAME has a value