Formulier wordt verzonden, dit kan even duren onderbreek het proces niet. Klik hier om te annuleren

Zoeken Menu

About
Html builder
Domiflows
Releasenotes
Mergecommands
Infrastructure
main site

About
Html builder
Domiflows
Releasenotes
Mergecommands
Infrastructure
main site

Home Workflow Request Object

Request API Reference

Information

The request object contains all data associated with the request that triggered the workflow. It can be used to access query parameters, headers, and the request body.

Although it is technically possible to modify the object, it should be treated as read-only. Overwriting its functions may lead to unpredictable behavior.

Usage

request:getHeader(key: string) --string | nil

Description

Checks if the requested "key" is found as a header on the request and returns it.

Usage

request:getJson() --string | nil

Description

Checks if the "Content-Type" header is set to "application/json" and returns the request body as a JSON table.

When the request body is not a valid JSON string, or the "Content-Type" header is not "application/json", the function will return nil.

Examples

-- This example assumes the request is made with a JSON body like:
-- { "name": "Bart" }
local tbl = request:getJson()
print("Your name is: ", tbl.name) --Bart

Usage

request:getParameter(key: string) --string | nil

Description

Checks if the requested "key" is found in the query string of the request and returns it.

Usage

request:getText() --string

Description

Returns the request body in text format.

Usage

request:getUrl() --table

Description

Returns a table holding the URL parts that were used in this request.

{ path: string, query: string }

Examples

-- Construct one URL from the request parts
local parts = request:getUrl()
local url = parts.path .. "?" .. parts.query
print(url) -- e.g. /workflow/api?path=Test&database=Example.nsf

Usage

request:getUser() --any | nil

Description

Since v254 Get the {{user}} that is associated with the request. The {{user}} has a default authentication state of "Authentication.Password". For more information, see {{user/user:setAuthentication}}.