API Developer Guide
How can we help?
Full Site Search

Common Questions For API Parameter

READ

ParameterCommon Question
where=<fieldId>,<filter_operator>,<value>

Some fields can contain special symbols such as spaces and newlines, and these symbols should be taken into account when filtering.

It is recommended to first fetch the data with an API request to inspect the field values, before constructing your filter query parameters.

WRITING

ParameterCommon Question
doLinkLoad=true

If the specified linked field value does not exist in the source sheet, the linked field and all relevant loaded fields values will be cleared.

Link and Load operation will overwrite the specified field value within the HTTP request.

doFormula=true

If the formula referred fields do not contain sensible values (i.e. empty field values or non-numeric values for arithmetic formulae), the formula field may have its value cleared.

Formula calculation will overwrite the specified field value within the HTTP request.

doWorkflow=true

Workflow can contain complex operations, it is indeed difficult to debug. We suggest comparing the result with the web version.

doDefaultValue=true

There are two types of default values:

(1) “create xxx”, with $ as the first symbol

(2) “last modified xxx”, with # as the first symbol

$ starting default values are only triggered on creation of a data entry, while # starting default values are triggered every update.

For example, $DATETIME is only triggered on data entry creation, while #DATETIME is triggered every update.

Top of Page Table of Contents

Start Ragic for Free

Sign up with Google