READ

Reads the values from a JSON object using the given key. Mainly used to read inbox payloads.

Syntax

=READ(Key, TargetCell, Type[, Direction, ErrorOnMissing])

Arguments

NameDescription
KeyA key to a data item, that should be read. The key is usually created by using utility functions like INBOXDATA, INBOXMETADATA, OUTBOXMETADATA or OUTBOXDATA. The key consists of the path to the item within the JSON object. Each path element is surrounded by brackets, Depending on the used utility function, you can retrieve data from different sources (e.g. Inbox or Outbox).
TargetCell or RangeOptional. Target cell or range to write the resulting value into.
TypeOptional. Type of Value. Allowed types are String, Number, Bool/Boolean, Array, Dictionary, Json or Jsonroot. The type defines the color of the target cell. Defaults to Json.
DirectionOptional. Specify TRUE to align keys vertically for type ARRAY, JSON or JSONROOT and horizontally for type DICTIONARY or RANGE. Defaults to TRUE.
ErrorOnMissingOptional. If this is set to TRUE #NA! will be returned if no data is available. If set to FALSE last read value will be returned or a default value if none was read before. Default is FALSE.

Return Value

The last part of the key of the data value to be retrieved.

Example

FunctionResultComment
=READ(INBOXDATA(“”, “”, “Customer”), B1, “String”)[[42]]Customer
=READ(INBOXDATA(“”, “”, “Customer”, “Name”), C2, “String”,,TRUE)#NAReturns error code if customer name is not available because last parameter is to TRUE.
=READ(INBOXDATA(,,”Products”,”0”),
F19:J25,”Dictionary”,,TRUE)
Read function with target range.Example to read a whole table with the help of the DICTIONARY() function and a target range.