REST.REQUEST

Create an https request. The result, of the request, if any, will be added to the Inbox of the given target sheet. You can use the Function Wizard for this function.

Syntax

=REST.REQUEST(Producer, Path, Method, Target, [ResultKeys], [Body], [Headers], [Timeout])

Arguments

Name Description
Producer Producer to use for submitting the rest.request.
Path Path extending the base URL of the connector.
Method HTTP method of the request.
Target INBOX(), OUTBOX(“MsgID”) or a cell range where the result will be placed.
ResultKeys Optional. Limit the result to the specified JSON Keys
Body Optional. Data to use as the body of the HTTP request.
Headers Optional. Headers of the HTTP request.
Timeout Optional. Number of ms after the request times out and an error is returned.

Return Value

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

Example

Function Result Comment
=REST.REQUEST(“Rest”, “/path”, “GET”, INBOX()) generated Request id This makes a GET request to “${baseURL}/path” and writes the result to the Inbox.

=REST.REQUEST(“Rest”, “/path”, “POST”, INBOX(“S2”),, “hello”,A2:B3)

REST.REQUEST
generated Request id This makes a POST request to “${baseURL}/path” with “hello” as body and “Content-Type: text/plain” and “Custom-Header: example” as headers. The response is placed in the Inbox of S2.