Function: datapoint.Get

Returns a filtered list of Datapoint Objects.

Syntax

{
	"method": "datapoint.Get",
	"params": {
		"mode": "...",
		"include": "...",
		"filter": "...",
		"sort": "...",
		"offset": "...",
		"limit": "...",
		"select": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
get(mode?: DataMode | undefined, include?: DataMode | undefined, filter?: DataFilter | undefined, sort?: DataSortItem[] | undefined, offset?: number | undefined, limit?: number | undefined): Promise<DatapointGetResult>;

Parameters

mode : DataMode optional

View of the objects to return: raw or effective. Default is effective.

include : DataMode optional

Adds the other view to the result; only values that differ are added (under @meta.overlay).

filter : DataFilter optional

Filter definition which determines the result set.

sort : DataSortItem[] optional

Sorting definition as a list of properties with order.

offset : int optional

Offset of the first Object in the result set that should be returned. Used for direct pagination.

limit : int optional

Maximum amount of Objects that should be returned.

select : string[] optional

List of properties that should be contained in the result objects.

Result : DatapointGetResult

Contains result objects and pagination info, if present.

Errors

Data.InvalidContext

The provided context cannot be used for pagination.

Data.InvalidCursor

The object referenced by the context cursor has been deleted. The entire pagination process needs to be restarted.

Data.InvalidFilterExpression

The provided filter expression has invalid syntax.

Remarks

This method requires API read access.