IExportDefinitionsQuery
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service to query exportDefinitions.
export interface IExportDefinitionsQuery
Methods
Method | Description |
|---|---|
(ALPHA) Starts the query. | |
(ALPHA) Sets filter for the query. | |
(ALPHA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 | |
(ALPHA) Sets number of exportDefinitions to return per page. Default size: 50 | |
(ALPHA) Sets sorting for the query. |
Method details
IExportDefinitionsQuery.query()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Starts the query.
query(): Promise<IExportDefinitionsQueryResult>;
Returns
Promise<IExportDefinitionsQueryResult>
promise of the first page of the results
IExportDefinitionsQuery.withFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets filter for the query.
withFilter(filter: {
title?: string;
}): IExportDefinitionsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
filter | { title?: string; } | filter to apply |
Returns
exportDefinitions query
IExportDefinitionsQuery.withPage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0
withPage(page: number): IExportDefinitionsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
page | number | zero indexed, must be non-negative |
Returns
exportDefinitions query
IExportDefinitionsQuery.withSize()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets number of exportDefinitions to return per page. Default size: 50
withSize(size: number): IExportDefinitionsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | desired max number of exportDefinitions per page must be a positive number |
Returns
exportDefinitions query
IExportDefinitionsQuery.withSorting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets sorting for the query.
withSorting(sort: ExportDefinitionQuerySort[]): IExportDefinitionsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
sort | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Returns
exportDefinitions query