The annotation information. The format of this object is decided by and validated against the annotationType
attribute.
A reference to an asset. Either the internal ID or the external ID must be provided (exactly one). A reference to an asset. Either the internal ID or the external ID must be provided (exactly one).
A reference to a file. Either the internal ID or the external ID must be provided (exactly one).
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.
Response from asset aggregate endpoint
Description of asset.
Name of asset. Often referred to as tag.
The source of this asset
Detect external ID or name of assets (from your CDF projects) in images. Usage of this feature requires ['assetsAcl:READ'] capability.
External Id provided by client. Should be unique within the project. The external ID provided by the client. Must be unique for the resource type.
A server-generated ID for the object.
Number of digits after comma in a digital gauge.
Defines a constraint across the properties you include.
You can use constraints to enforce that; Certain properties must be present, A value must be unique across a single or several properties.
A 'uniqueness' constraint can only apply to properties that are in the same container. Up to 10 'uniqueness' constraints can be added per container.
A 'requires' constraint can reference other containers. As a result, the properties in those other containers must then also be set. Up to 25 'requires' constraints can be added per container.
Defines a property of a container. You can reference this property in views.
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
}
Property you want to filter. Use a list of strings to specify nested properties. Property you want to filter. Use a list of strings to specify nested properties. Property you want to filter. Use a list of strings to specify nested properties.
Example:
You have the object
{
"room": {
"id": "b53"
},
"roomId": "a23"
}
Use ["room", "id"] to return the value in the nested id property, which is a part of the room object.
You can also read the value(s) in the standalone property roomId with ["roomId"].
Example:
You have the object
{
"room": {
"id": "b53"
},
"roomId": "a23"
}
Use ["room", "id"] to return the value in the nested id property, which is a part of the room object.
You can also read the value(s) in the standalone property roomId with ["roomId"].
Example:
You have the object
{
"room": {
"id": "b53"
},
"roomId": "a23"
}
Use ["room", "id"] to return the value in the nested id property, which is a part of the room object.
You can also read the value(s) in the standalone property roomId with ["roomId"].
Build a new query by combining other queries, using boolean operators. We support the and, or, and
not boolean operators.
Build a new query by combining other queries, using boolean operators. We support the and, or, and
not boolean operators.
Build a new query by combining other queries, using boolean operators. We support the and, or, and
not boolean operators.
Leaf filter Leaf filter Leaf filter
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
The angle between the start and end point on the bottom part of an analog gauge, measured in degrees.
A default group for all project users. Can be used to establish default capabilities. WARNING: this group may be logically deleted
Detect and read value of dial gauges in images. In beta. Available only when the cdf-version: beta header is provided.
Detect and read value of digital gauges in images. In beta. Available only when the cdf-version: beta header is provided.
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
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.
Find all metadata property names
Paginated list of all unique values for given properties.
Find approximate number of unique properties.
Find approximate number of unique values.
Count of documents.
Top unique metadata property names
Top unique values for given properties.
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. 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.
An object containing file (external) id.
A filter Domain Specific Language (DSL) used to create advanced filter queries. A filter Domain Specific Language (DSL) used to create advanced filter queries. A filter Domain Specific Language (DSL) used to create advanced filter queries.
Search stream returns a string of delimited json of features (GeospatialFeatureResponse[]). jsonStreamFormat in the filter decides what the delimiter will be.
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.
The identity type field indicates the type of principal.
USER: Human user.SERVICE_PRINCIPAL: Service account.INTERNAL_SERVICE: Internal CDF service.The identity type filter field indicates the type of principal the request should be filtered to show.
If no value is specified, the default value is USER.
ALL: All types of principals.USER: Human user.SERVICE_PRINCIPAL: Service account.INTERNAL_SERVICE: Internal CDF service.Should we return property type information as part of the result?
You can optimize query performance by defining an index to apply to a container. You can only create an index across properties belonging to the same container.
Ordering of the properties included in the index definition list is significant. The order should match the queries you expect. Once we create an index, you may only change its description. We do not currently support removal of an index.
Indexes have different requirements for the different property data types. As a result, the create index operation will fail if you specify an invalid combination.
Up to 10 indexes can be added on a container.'
Detect industrial objects such as gauges and valves in images. In beta. Available only when the cdf-version: beta header is provided.
The type of instance
Range between two integers
Contextualization job ID.
The status of the job.
A list of the labels associated with this resource item.
Detect and read value of level gauges in images. In beta. Available only when the cdf-version: beta header is provided.
The url to send the user to in order to log out
The max value of the gauge.
Maximum number of digits on a digital gauge.
The min value of the gauge.
Minimum number of digits on a digital gauge.
The cursor value used to return (paginate to) the next page of results, when more data is available. The cursor value used to return (paginate to) the next page of results, when more data is available. The cursor value used to return (paginate to) the next page of results, when more data is available. The cursor value used to return (paginate to) the next page of results, when more data is available. The cursor value used to return (paginate to) the next page of results, when more data is available.
Searching nodes or edges using properties from a view
If the gauge is nonlinear, the non-linear angle from the metadata is used to part the scale in two separate linear scales. The first scale goes from min to 0. The second from 0 to max. The needle angle determines which scale is used.
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.
Detect people in images.
Detect personal protective equipment, such as helmet, protective eyewear, and mask in images. In beta. Available only when the cdf-version: beta header is provided.
The display name of the project.
Group of property values indexed by a local unique identifier. The identifier has to have a length of between 1 and 255 characters. It must also match the pattern ^[a-zA-Z0-9][a-zA-Z0-9_-]{0,253}[a-zA-Z0-9]?$ , and it cannot be any of the following reserved identifiers: space, externalId, createdTime, lastUpdatedTime, deletedTime, and extensions. The maximum number of properties depends on your subscription, and is by default 100.
Value you wish to find in the provided property using a range clause. Value you wish to find in the provided property using a range clause. Value you wish to find in the provided property using a range clause.
A list of values A list of values A list of values
A value matching the data type of the defined property A value matching the data type of the defined property A value matching the data type of the defined property
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
Reference to a view, or a container Reference to a view, or a container Reference to a view, or a container
Retrieve properties from the listed - by reference - views.
Control which side of the edge to chain to. This option is only applicable if the view referenced in the from field consists of edges.
source will chain to start if you're following edges outwards i.e direction=outwards. If you're following edges inwards i.e direction=inwards, it will chain to end.destination (default) will chain to end if you're following edges outwards i.e direction=outwards. If you're following edges inwards i.e direction=inwards, it will chain to start.Build a new query by combining other queries, using boolean operators. We support the and, or, and
not boolean operators.
A filter Domain Specific Language (DSL) used to create advanced filter queries.
Leaf filter
Detect text in images.
The confidence threshold returns predictions as positive if their confidence score is the selected value or higher. A higher confidence threshold increases precision but lowers recall, and vice versa.
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.
Type information for the returned properties (if requested)
Spaces for the requested view and containers
Describes the type and configuration of a property included in the result.
View or container holding properties
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.
Should this operation apply to nodes, edges or both. Should this operation apply to nodes, edges or both. Should this operation apply to nodes, edges or both.
List of valid domains. If left empty, any user registered with the OAuth2 provider will get access.
Detect and read state of a valve in an image. In beta. Available only when the cdf-version: beta header is provided.
A reference to a container property (ViewProperty) or a connection describing edges that are expected to exist (ConnectionDefinition). A reference to a container property (ViewProperty) or a connection describing edges that are expected to exist (ConnectionDefinition).
If the referenced container property is a direct relation, a view of the node can be specified. The view is a hint to the consumer on what type of data is expected to be of interest in the context of this view.
A connection describes the edges that are likely to exist to aid in discovery and documentation of the view. A listed edge is not required. i.e. It does not have to exist when included in this list. The target nodes of this connection will match the view specified in the source property. A connection has a max distance of one hop in the underlying graph.
If the referenced container property is a direct relation, a view of the node can be specified. The view is a hint to the consumer on what type of data is expected to be of interest in the context of this view.
A connection describes the edges that are likely to exist to aid in discovery and documentation of the view. A listed edge is not required. i.e. It does not have to exist when included in this list. The target nodes of this connection will match the view specified in the source property. A connection has a max distance of one hop in the underlying graph.
Direct node relation. Can include a hint to specify the view that this direct relation points to. This hint is optional. Direct node relation. Can include a hint to specify the view that this direct relation points to. This hint is optional. Direct node relation. Can include a hint to specify the view that this direct relation points to. This hint is optional.
View or container holding properties
Property definition Property definition
The external ID of a file in CDF.
The ID of a file in CDF.
It verify if credentials contain require fields depending each method.
ClientCredentials
It verify if options contain require fields .
An aggregate. It consists of a name, an aggregator function, and the field to use for the function.