Start of change

HTTP_PUT_VERBOSE and HTTP_PUT_BLOB_VERBOSE

The HTTP_PUT_VERBOSE Start of changeor HTTP_PUT_BLOB_VERBOSEEnd of change table function updates a text-based resource under the specified URL through an HTTP PUT request. It returns a one row table that contains the normal HTTP response for the request and the header information returned from the HTTP request.

Read syntax diagramSkip visual syntax diagramHTTP_PUT_VERBOSEHTTP_PUT_BLOB_VERBOSE(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 specifies the data to update at the specified URL.
For HTTP_PUT_VERBOSE, it must be a built-in character string or graphic string data type.
Start of changeFor HTTP_PUT_BLOB_VERBOSE, it must be a built-in binary string data type.End of change
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 table containing a single row with the format shown in the following table.

Table 1. HTTP_PUT_VERBOSE and HTTP_PUT_BLOB_VERBOSE result table
Column name Data type Description
RESPONSE_MESSAGE
CLOB(2G) CCSID 1208 for
HTTP_PUT_VERBOSE
Start of changeor
BLOB(2G)  for
HTTP_PUT_BLOB_VERBOSEEnd of change
The HTTP response for the request.
RESPONSE_HTTP_HEADER CLOB(2G) CCSID 1208 Header information returned from the HTTP request, formatted as specified by the verboseResponseHeaderFormat option.

Notes

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

Example

  • Send a HTTP PUT request to https://www.example.com/users sending 'ABC' and using the certificate store /home/javaTrustStore/fromJava.KDB. Return the result and header information.
    SELECT * FROM TABLE(QSYS2.HTTP_PUT_VERBOSE(
                        'https://www.example.com/users',
                        'ABC',
                        '{"sslCertificateStoreFile":"/home/javaTrustStore/fromJava.KDB"}'));
End of change