On this Page:
Tagged Values
<<E2EHTTPService>>
Name Dialog / Tag | Description | Allowed Values / Examples | |||||
---|---|---|---|---|---|---|---|
Port (port) | Specifies the machine port number the service is binding to. This port number can be given at the service level only. | 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 +40000 | default | ||||||
Authentication Mode (authenticationMode) | Defines the authentication mode to be used with this SOAP service.
Independent of the authentication mode, the user is found in the principal object if the authentication succeeded. | none | no authentication | ||||
HTTPBasicAuth | HTTP basic authentication | ||||||
HTTPRemoteAuth | HTTP remote authentication | ||||||
User (user) | Specifies user and password for the use of HTTP Basic authentication. | user/password |
HTTP Port Type Operation Parameters
Name | Type | Direction | Description |
---|---|---|---|
method | String | in | Specifies the HTTP method. |
uri | String | in | Specifies the complete URI. |
inputContent | Blob | in | Specifies the HTTP content send by POST or PUT. |
getParameters | Array of Parameter | in | Specifies all GET parameters encoded in the URL as an array of Parameter classes containing name/value pairs. |
postParameters | Array of Parameter | in | Specifies all form parameters posted by the client. |
inputHeaderParameters | Array of HeaderField | in | Specifies all header fields as an array of HeaderField classes containing name/value pairs. |
pathParameters | Map | in | For RESTful service calls: Specifies all parameters derived from the path as a Map of name/value pairs. |
outputContent | Blob | out | Contains the content sent back. |
outputHeaderParameters | Array of HeaderField | out | Use this parameter to set the HTTP output header if necessary. |
httpStatusDescription | String | out | 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 | Integer | out | 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 Type | Attribute | Type | Description | Values/Example |
---|---|---|---|---|
HeaderField | name | String | Name of the header field. | |
value | String | Value of the header field. | ||
Parameter | name | String | Name of the parameter. | |
value | String | Value of the Parameter. |
Overview
Content Tools