Start of change

HTTP_PUT

The HTTP_PUT scalar function retrieves a text-based resource from the specified URL through an HTTP PUT request.

Read syntax diagramSkip visual syntax diagramHTTP_PUT(url ,request-message,options)
url
An expression that returns a built-in character string or graphic string data type that specifies the URL of the resource being accessed.
The only supported protocols in the URL are http:// and https://. HTTP basic authentication in the form https://userid:password@ cannot be specified in the URL. Instead, the basicAuth option must be used to specify the userid and password for basic authentication.
request-message
An expression that returns a built-in character string or graphic string data type that specifies the data to update at the specified URL.
options
An expression that returns a built-in character string or graphic string data type. This string must be formatted as a JSON object containing the options, including headers, for the request. See HTTP options for the list of options.
If no options are provided, the default options are used.

The result of the function is a CLOB(2G) CCSID 1208 containing the response message.

Notes

For more information about using the HTTP functions see HTTP functions overview.

To return the header information from the HTTP request, use the HTTP_PUT_VERBOSE table function: HTTP_PUT_VERBOSE

Example

  • Send a HTTP PUT request to https://www.example.com/users sending 'ABC' and using the certificate store /home/javaTrustStore/fromJava.KDB and return the result.
    VALUES QSYS2.HTTP_PUT('https://www.example.com/users',
                          'ABC',
                          '{"sslCertificateStoreFile":"/home/javaTrustStore/fromJava.KDB"}');
End of change