Function: data.Get

Generic Get function for all data types. The type is selected by parameter, the rest behaves the same as type specific services.

Syntax

{
	"method": "data.Get",
	"params": {
		"type": "...",
		"mode": "...",
		"include": "...",
		"filter": "...",
		"sort": "...",
		"limit": "...",
		"offset": "...",
		"select": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<GetResult<value>> Get( AdvString type
	 std::optional<AdvString> mode = std::nullopt,
	 std::optional<AdvString> include = std::nullopt,
	 std::optional<DataFilter> filter = std::nullopt,
	 std::optional<std::vector<DataSortItem>> sort = std::nullopt,
	 std::optional<int> limit = std::nullopt,
	 std::optional<int> offset = std::nullopt,
	 std::optional<std::vector<AdvString>> select = std::nullopt );
public Task<GetResult<object?>> GetAsync(string type,
		DataMode? mode = null,
		DataMode? include = null,
		DataFilter? filter = null,
		IList<DataSortItem>? sort = null,
		long? limit = null,
		long? offset = null,
		CancellationToken ct = default);
get(type: string, mode?: DataMode | undefined, include?: DataMode | undefined, filter?: DataFilter | undefined, sort?: DataSortItem[] | undefined, limit?: number | undefined, offset?: number | undefined): Promise<GetResultvalue>;

Parameters

type : string

Selects the type of Data Object.

mode : string (DataMode) optional

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

include : string (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.

limit : int optional

Maximum amount of Objects that should be returned. Must be a non-negative integer.

offset : int optional

Offset of the first Object in the result set that should be returned. Used for direct pagination. Must be a non-negative integer.

select : string[] optional

A list of fields which the result objects should contain (empty or missing means a default field set will be returned).

Result : GetResult

Contains result objects and pagination info, if present.

Errors

Data.InvalidFilterExpression

The provided filter expression has invalid syntax.

Remarks

This method requires API read access.