/AWS1/CL_MDTHTTPREQUESTCONF¶
-- Function Configuration DataStructure
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_runtime TYPE /AWS1/MDTRUNTIMETYPE /AWS1/MDTRUNTIMETYPE¶
The expression language used to evaluate expressions in the function configuration. Set this to
JSONata.
iv_methodtype TYPE /AWS1/MDTMETHODTYPE /AWS1/MDTMETHODTYPE¶
The HTTP method for the request. Valid values:
GETandPOST.
iv_reqtimeoutmilliseconds TYPE /AWS1/MDT__INTEGER /AWS1/MDT__INTEGER¶
The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to
nulland proceeds with output expression evaluation. Valid values:100to2000.
iv_url TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING¶
An expression that evaluates to the request URL. Use
{%...%}delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.
Optional arguments:¶
it_output TYPE /AWS1/CL_MDT__MAPOF__STRING_W=>TT___MAPOF__STRING TT___MAPOF__STRING¶
A map of output bindings. Each key is a namespaced output path (such as
player_params.device_typeortemp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in anHTTP_REQUESTfunction can reference theresponseobject returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
iv_body TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING¶
An expression that evaluates to the request body. Used with
POSTrequests. The maximum size after evaluation is 64 KB.
it_headers TYPE /AWS1/CL_MDT__MAPOF__STRING_W=>TT___MAPOF__STRING TT___MAPOF__STRING¶
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound HTTP request. Maximum 50 headers.
Queryable Attributes¶
Runtime¶
The expression language used to evaluate expressions in the function configuration. Set this to
JSONata.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RUNTIME() |
Getter for RUNTIME, with configurable default |
ASK_RUNTIME() |
Getter for RUNTIME w/ exceptions if field has no value |
HAS_RUNTIME() |
Determine if RUNTIME has a value |
Output¶
A map of output bindings. Each key is a namespaced output path (such as
player_params.device_typeortemp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in anHTTP_REQUESTfunction can reference theresponseobject returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPUT() |
Getter for OUTPUT, with configurable default |
ASK_OUTPUT() |
Getter for OUTPUT w/ exceptions if field has no value |
HAS_OUTPUT() |
Determine if OUTPUT has a value |
MethodType¶
The HTTP method for the request. Valid values:
GETandPOST.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METHODTYPE() |
Getter for METHODTYPE, with configurable default |
ASK_METHODTYPE() |
Getter for METHODTYPE w/ exceptions if field has no value |
HAS_METHODTYPE() |
Determine if METHODTYPE has a value |
RequestTimeoutMilliseconds¶
The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to
nulland proceeds with output expression evaluation. Valid values:100to2000.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQTIMEOUTMILLISECONDS() |
Getter for REQUESTTIMEOUTMILLISECONDS, with configurable def |
ASK_REQTIMEOUTMILLISECONDS() |
Getter for REQUESTTIMEOUTMILLISECONDS w/ exceptions if field |
HAS_REQTIMEOUTMILLISECONDS() |
Determine if REQUESTTIMEOUTMILLISECONDS has a value |
Url¶
An expression that evaluates to the request URL. Use
{%...%}delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_URL() |
Getter for URL, with configurable default |
ASK_URL() |
Getter for URL w/ exceptions if field has no value |
HAS_URL() |
Determine if URL has a value |
Body¶
An expression that evaluates to the request body. Used with
POSTrequests. The maximum size after evaluation is 64 KB.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BODY() |
Getter for BODY, with configurable default |
ASK_BODY() |
Getter for BODY w/ exceptions if field has no value |
HAS_BODY() |
Determine if BODY has a value |
Headers¶
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound HTTP request. Maximum 50 headers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEADERS() |
Getter for HEADERS, with configurable default |
ASK_HEADERS() |
Getter for HEADERS w/ exceptions if field has no value |
HAS_HEADERS() |
Determine if HEADERS has a value |