Function: station.Get
Returns a filtered list of Station Objects.
Syntax
{
"method": "station.Get",
"params": {
"mode": "...",
"include": "...",
"filter": "...",
"sort": "...",
"offset": "...",
"limit": "...",
"select": "...",
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}AdvFuture<StationGetResult> Get( 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> offset = std::nullopt,
std::optional<int> limit = std::nullopt,
std::optional<std::vector<AdvString>> select = std::nullopt );public Task<StationGetResult> GetAsync(DataMode? mode = null,
DataMode? include = null,
DataFilter? filter = null,
IList<DataSortItem>? sort = null,
long? offset = null,
long? limit = null,
CancellationToken ct = default);get(mode?: DataMode | undefined, include?: DataMode | undefined, filter?: DataFilter | undefined, sort?: DataSortItem[] | undefined, offset?: number | undefined, limit?: number | undefined): Promise<StationGetResult>;Parameters
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.
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. (Max : 100000)
select : string[] optional
List of properties that should be contained in the result objects.
Result : StationGetResult
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.