Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 20.1c

...

Multiexcerpt
MultiExcerptNameREST_Parameter_Types

Request

AttributeTypeDescriptionValues/Example
methodHTTPMethodHTTP method used in call.GET
headersArray of HeaderField
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehttpHeaders_depr
PageWithExcerptINTERNAL:_bridge_excerpts

All HTTP request header fields as an array of HeaderField classes containing name/value pairs. The header fields contain the standard HTTP headers as well as header parameters, if provided.


queryStringStringQuery string, if provided with the call.status=in%20progress
queryParametersArray of ParameterAll query parameters as an array of Parameter classes containing name/value pairs.
bodyBlobBody of the HTTP request.
pathStringPath to the REST resource./support/supportcases/
pathParametersMapAll REST parameters as a map.
httpHeaderMapMap of Entry
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehttpHeaderMap
PageWithExcerptINTERNAL:_bridge_excerpts

Response

AttributeTypeDescriptionValues/Example
headersArray of HeaderFieldAll HTTP response header fields as an array of HeaderField classes containing name/value pairs.
statusCodeIntegerThe resulting HTTP status code. If not set explicitly using this object, the service returns 200 if no exception occurred, or 500 otherwise.404
errorObjectAnyObject of the type defined with stereotype <<RESTError>>.

RequestOptions

Multiexcerpt
MultiExcerptNameRequestOptions
AttributeTypeDescriptionValues/Example
additionalHeadersArray of HeaderFieldAll REST request header fields as an array of HeaderField classes containing name/value pairs.
optionsArray of Option

Specify native cURL options as listed in Setting cURL Options on the URL Adapter .

Use one of the following syntax rules:

  • values separated by ',' in one line
  • values separated by ' ' in one line
  • list of tagged values

sslSSLUse this parameter to supply SSL information.
proxyProxyUse this parameter to supply necessary proxy information.
additionalQueryParametersArray of Parameter Use this parameter to provide additional query parameters to the REST service call.
followRedirectsIntegerSpecify here the maximum number of redirects to follow.any integer
basicAuthAuthenticationThis parameter provides an object of type Authentication containing the user and the password.
basePathStringOverwrite here the base path of the REST service.a valid path, e.g. /support
hostStringOverwrite here the host running the REST service that has been defined in the component diagram.
portIntegerOverwrite here the port through which the REST service is accessible.
protocolStringOverwrite here the protocol through which the REST service is accessible.http, https
ignoreHttpErrorsBooleanIf true, HTTP error codes >= 400 will not cause an exception in the model. This implies, that the response body is accessible even if HTTP errors occur. Default value is true.true / false
jsonComposerOptionsComposerOptionsUse this parameter to specify JSON composer options on the REST call. You can use these options to e.g. overwrite jsonKeepNulls from the REST alias.

AdapterResponse

Multiexcerpt
MultiExcerptNameAdapterResponse
AttributeTypeDescriptionValues/Example
httpStatusIntegerHTTP status code of the adapter call.500
headersArray of HeaderField
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehttpHeaders_depr
PageWithExcerptINTERNAL:_bridge_excerpts

HTTP headers of HTTP response.


bodyBlobHTTP body of HTTP response.
responseObjectAny

Response Object of the REST adapter call.

  • If the adapter had an error, the responseObject is an <<RESTError>> class. It could be the default error class or a specific error class dependent on the <<RESTResponseDefinition>> dependencies and the HTTP status code.
  • If the adapter call had no error, the responseObject is the same as the response output parameter.

httpHeaderMapMap of Entry
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehttpHeaderMap
PageWithExcerptINTERNAL:_bridge_excerpts

Request and Response Types

REST TypeAttributeTypeDescriptionValues/Example
AuthenticationusernameStringUsername.
passwordStringPassword.
CertificatefileStringCertificate file.
typeString

ComposerOptionskeepNullsBooleanKeep NULL values during JSON composing.
EntrykeyStringKey of the map entry.
valueArray of AnyList of values of the map entry. The dynamic type for httpHeaderMap is String.
HTTPMethod
enumerationList of all valid HTTP methodsDELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT
HeaderFieldnameStringName of the header field.
valueStringValue of the header field.
OptionnameStringName of the option.
valueStringValue of the option.
ParameternameStringName of the parameter.
valueStringValue of the Parameter.
ProxyurlStringURL.A valid URL.
typeString

authenticationAuthenticationSee above.
SSLverifyPeerString

verifyHostString

caInfoString

certificateCertificateSee above.
keyKey