NAME¶

request-body - (request-data)

PURPOSE¶

Get the body of an HTTP request.

SYNTAX¶

request-body <request body> 

DESCRIPTION¶

request-body stores the request body of an HTTP request into string <request body>.

If the content type of the request is "multipart/form-data", the request body is empty because all the data (including any attached files) can be obtained by using get-param (see file-uploading for files). In all other cases, request body is available.

Typical use of request-body is when some text or binary information is attached to the request, such as JSON for example, though it can be anything else, for example an image, some text, or a PDF document. Usually request body is present for POST, PUT or PATCH requests, but you can also obtain it for GET or DELETE requests, if supplied (for instance identifying a resource may require more information than can fit in a query string), or for any custom request method.

EXAMPLES¶

String variable "reqb" will hold request body of a request:

request-body reqb

SEE ALSO¶

Request data

get-param request-body set-param See all documentation