Response from asset aggregate endpoint
Description of asset.
Name of asset. Often referred to as tag.
The source of this asset
External Id provided by client. Should be unique within the project.
Contextualization job ID.
A Promise to a response that can be awaited like normal, but at the risk of not getting all results due to API limits. In which case a nextCursor field is returned to request the next page. Helper methods are provided to abstract away the pagination.
Example using client.timeseries.list with a per-request limit of 1000:
const response = client.timeseries.list({ filter: { assetIds: [ASSET_ID] }, limit: 1000 });You can get up to 1000 elements with normal await:
const { items, nextCursor } = await response;You can use autoPagingToArray to get more items than the per-request limit.
E.g. an array of up to 5000 items:
const timeseries = await response.autoPagingToArray({ limit: 5000 });You may also specify { limit: Infinity } to get all results.
You can also iterate through all items (unless you break out of the loop) like so:
for await (const value of response) {
// do something to value
}Write-protected data sets impose additional restrictions on write access to resources inside a data set which can help ensuring data integrity of the data set. For write-protected data set in addition to a writing capability that has given resource data in scope, principal must be an owners of the data set. Note that this does not affect any security categories set for given resource data, both security category membership and data set ownership is required in such case
A default group for all project users. Can be used to establish default capabilities. WARNING: this group may be logically deleted
A JSON based filtering language. See detailed documentation above.
A query that matches items matching boolean combinations of other queries.
It is built using one or more boolean clauses, which can be of types: and, or or not
Leaf filter
Property you wish to filter. It's a list of strings to allow specifying nested properties.
For example, If you have the object {"foo": {"../bar": "baz"}, "bar": 123}, you can refer to the nested property as ["foo", "../bar"] and the un-nested one as ["bar"].
Value you wish to find in the provided property using a range clause.
Value you wish to find in the provided property.
One or more values you wish to find in the provided property.
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
Response from event aggregate endpoint
Prefix filter on externalId. (case-sensitive)
Response from file aggregate endpoint
File type. E.g. text/plain, application/pdf, ...
Name of the file.
Name of the group
ID of the group in the source. If this is the same ID as a group in the IDP, a user in that group will implicitly be a part of this group as well.
Range between two integers
A list of the labels associated with this resource item.
The url to send the user to in order to log out
Splits the data set into N partitions.
This should NOT be used for frontend applications.
Partitions are formatted as n/m, where n is the index of the parititon, and m is the total number or partitions.
i.e. 20 partitions would have one request with partition: 1/20, then another partition: 2/20 and so on.
You need to use autoPagingToArray(...) on each partition in order to receive all the data.
The display name of the project.
Response from sequence aggregate endpoint
Description of the column
Human readable name of the column
Description of the sequence
Element of type corresponding to the column type. May include NULL!
Name of the sequence
A request for datapoints stored
What type the datapoints in a column will have. DOUBLE is restricted to the range [-1E100, 1E100]
Unique name of the service account
Items can be sorted in either ascending or descending order
Response from timeseries aggregate endpoint
Whether the time series is a step series or not.
Whether the time series is string valued or not.
Name of time series
The physical unit of the time series.
A point in time, either a number or a Date object. The Date is converted to a number when api calls are made.
The url name of the project. This is used as part of API calls. It should only contain letters, digits and hyphens, as long as the hyphens are not at the start or end.
List of valid domains. If left empty, any user registered with the OAuth2 provider will get access.
List of domains permitted for redirects. Redirects as part of a login flow may only target a domain (or subdomain) on this list. If this list is set to be empty, it will not be possible to use a login flow.