Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 24.0
Div
Classe2e-refDiv

Otp
Floatingfalse

Rp

Tagged Values

<<E2EHTTPService>>

Multiexcerpt
MultiExcerptNameE2EHTTPService
Name Dialog / TagDescriptionAllowed Values / Examples
Port
(port)

Multiexcerpt include
MultiExcerptNameport
nopaneltrue
PageWithExcerptSOAP Service Reference

any number
Using ports below 1024 may require additional privileges.
Trace Port
(tracePort)
In order to test the HTTP service using the Trace Analyzer, the model compiler generates a SOAP interface for each HTTP service interface. The SOAP service will be listening on this trace port.any positive integer
service port +40000default
Max Request Body Size
(maxRequestBodySize)

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamemax_request_body_size
PageWithExcerptINTERNAL:_bridge_excerpts

Info
iconfalse

If you have multiple HTTP services in one composite, you can only apply the same value to all. If you specify different values on each of them, the Runtime will pick one and apply them to all.

any positive integer
0Accept unlimited requests (default of services compiled with Builder versions < 7.12.0).
2048Builder 7.12.0 2MB, default if not specified
Max Request Header Size
(maxRequestHeaderSize)

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamemax_request_header_size
PageWithExcerptINTERNAL:_bridge_excerpts

Info
iconfalse

If you have multiple HTTP services in one composite, you can only apply the same value to all. If you specify different values on each of them, the Runtime will pick one and apply them to all.

any positive integer
88 KB (default if not specified).
Authentication Mode
(authenticationMode)

Multiexcerpt include
MultiExcerptNameauthenticationMode
nopaneltrue
PageWithExcerptSOAP Service Reference

noneno authentication 
HTTPBasicAuthHTTP basic authentication
HTTPRemoteAuthHTTP remote authentication

User
(user)

Specifies user and password for the use of HTTP Basic authentication.user/password 

HTTP Port Type Operation Parameters

Multiexcerpt
MultiExcerptNamehttp_parameters
NameTypeDirectionDescription
methodStringinSpecifies the HTTP method.
uriStringinSpecifies the complete URI.
inputContentBlobinSpecifies the HTTP content send by POST or PUT.
getParameters Array of ParameterinSpecifies all GET parameters encoded in the URL as an array of Parameter classes containing name/value pairs.
postParameters Array of ParameterinSpecifies all form parameters posted by the client.
inputHeaderParameters Array of HeaderFieldin
Note
iconfalse

DeprecatedThis attribute is deprecated as of Runtime 2020.11. Please use inputHttpHeaderMap (see below) for new implementations as its implementation complies to the HTTP specification.

Specifies all header fields as an array of HeaderField classes containing name/value pairs.

pathParametersMapinFor RESTful service calls: Specifies all parameters derived from the path as a Map of name/value pairs.
inputHttpHeaderMapMap of Entryin
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehttpHeaderMap
PageWithExcerptINTERNAL:_bridge_excerpts
outputContent BloboutContains the content sent back.
outputHeaderParameters Array of HeaderFieldoutUse this parameter to set the HTTP output header if necessary.
httpStatusDescription StringoutContains the resulting HTTP status description. If not set explicitly using this object, the service returns OK if no exception occurred or Internal Error otherwise.
httpStatusCode IntegeroutContains the resulting HTTP status code. If not set explicitly using this object, the service returns 200 if no exception occurred or 500 otherwise.

Parameter Types

REST TypeAttributeTypeDescriptionValues/Example
EntrykeyStringKey of the map entry.
valueArray of AnyList of values of the map entry.
HeaderFieldnameStringName of the header field.
valueStringValue of the header field.
ParameternameStringName of the parameter.
valueStringValue of the Parameter.
Panel
titleOn this Page:
Table of Contents
Panel
titleRelated Pages: