Getting started
Authentication
Services
- Dataset service
- Batches and BatchRuns
- Combining entities in one request
- Latest data URL
- Stream URL
- Batchrun URL
- Archive URL
- Timeseries URL
Request parameters
- Parameters
- Parameter: after
- Parameter: aggregate
- Parameter: apikey
- Parameter: dateFormat
- Parameter: descending
- Parameter: envelope
- Parameter: format
- Parameter: from
- Parameter: groupBy
- Parameter: groupById
- Parameter: inline
- Parameter: limit
- Parameter: Lookup Fields
- Parameter: modulus
- Parameter: nextUrl
- Parameter: part
- Parameter: rangeField
- Parameter: requestTimeout
- Parameter: showMessage
- Parameter: sortBy
- Parameter: to
- Parameter: verifyLinks
Reference
Samples
Parameter: Lookup Fields
Applies to
Applies to: history
Value
Comma-separated field values
Applies to: dot_lookup
Lookup fields on related entities can be used with a dot syntax. For example, ${referenceField}.${dottedLookup} looks up ${reference0} by the ${dottedLookup} value of the related ${reference1}. Both fields in the dotted lookup must be defined as lookup fields.
Note: Specifically for
*.iddotted lookups (such as${referenceField}.id), the lookup can be abbreviated to${referenceField}for example (dropping the ".id" part).
Tip: Where more then one lookup field is used in a request, the result is the logical AND of the two lookup fields. For example if the arguments
...lookupField1=X&lookupField2=Y...are used, the REST API will only return instances which match both lookup fields.