|
|
|
|
|
|
|
|
|
|
- Properties specific to apiRequest variables
apiRequest (Type of request) In french: apiRequête
The apiRequest type is used to define all the advanced characteristics of a request executed via a REST web service imported using the OpenAPI documentation. These characteristics can be defined and changed using different WLanguage properties. Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable. Req is apiRequest
Req.HTTPHeader["key"] = "Value"
MyWebService.GetUserList(Req, param1_WS, param2_WS)
Properties Properties specific to apiRequest variables The following properties can be used to handle apiRequest variables: | | | | Property name | Type used | Effect |
|---|
| ClientCertificate | String or buffer | Corresponds to: - a character string with an access path to the .p12 file that contains the certificate to attach to the request. The certificate will be automatically loaded taking into account:
- the certificate in the executable library (if it has been integrated into the application),
- the certificate at the specified location on disk (if the certificate has not been integrated into the executable library).
- a buffer with the certificate (fLoadBuffer).
If this property is set to an empty string (""), the default certificate is reset to "<None>". | | HTTPHeader | Associative array of character strings | Key/Value set of headers to send. Usage example of this property: cMyRequest.HTTPHeader["Authorization"] = ...
" WSSE profile=""UsernameToken"""
cMyRequest.HTTPHeader["X-WSSE"] = ...
"UsernameToken Username=blahblah "
cMyRequest.Header["Cache-Control"] = " no-cache"
| | ClientCertificatePassword | Character string | Password associated with the client certificate (empty string by default) | | ConnectionTimeout | Integer or Duration | Maximum timeout for the connection expressed in milliseconds (20 seconds by default, i.e. 20000 milliseconds). This property can correspond to: - an integer representing the number of milliseconds,
- a Duration variable,
- the duration in a readable format (e.g., 20 s or 20000 ms).
The connection fails if it cannot be established within this period. |
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|