REQUEST

Create an https request. The request parameters are defined by creating a message. The parameter definition can be derived from: https://github.com/request/request#requestoptions-callback . The result, of the request, if any, will be added to the Inbox of the given target sheet.

Syntax

=REQUEST(Producer, ParameterJSON, Target[,ResultKeys, Timeout])

Arguments

Name

Description

Producer

Producer to use for submitting the request.

ParameterJSON

Message with JSON Structure defining the request parameters.

Target

INBOX(), OUTBOX(“MsgID”) or a cell range where the result will be placed.

ResultKeys

Optional. Limit the result to the specified JSON Keys

Timeout

Optional. Number of ms after the request times out and an error is returned.

Return Value

The function REQUEST() always returns a unique random request ID, which is automatically generated when the service is called.

Example

Function

Result

Comment

=REQUEST(“Rest”, OUTBOX(“Message”), INBOX(“S2”))

generated Request id

The message must exist before calling REQUEST. It is created like a normal message, which you would like to publish, using the WRITE formula.