IExportDefinitionsQueryOptions
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Configuration options for querying exportDefinitions
export interface IExportDefinitionsQueryOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Filter exportDefinitions by their author. The value of this property is identifier of the author. | ||
number | (ALPHA) (Optional) Specify number of items per page. Default: 50 | ||
boolean | (ALPHA) (Optional) Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition. | ||
number | (ALPHA) (Optional) Specify (zero-based) starting offset for the results. Default: 0 | ||
(ALPHA) (Optional) Specify ordering of the exportDefinitions. Default: natural ordering provided by the analytical backend. | |||
string | (ALPHA) (Optional) Filter exportDefinitions by their title |
Property details
IExportDefinitionsQueryOptions.authorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Filter exportDefinitions by their author. The value of this property is identifier of the author.
author?: string;
IExportDefinitionsQueryOptions.limitpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify number of items per page. Default: 50
limit?: number;
IExportDefinitionsQueryOptions.loadUserDatapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition.
loadUserData?: boolean;
Remarks
Defaults to false.
IExportDefinitionsQueryOptions.offsetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify (zero-based) starting offset for the results. Default: 0
offset?: number;
IExportDefinitionsQueryOptions.orderBypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify ordering of the exportDefinitions. Default: natural ordering provided by the analytical backend.
orderBy?: ExportDefinitionOrdering;
IExportDefinitionsQueryOptions.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Filter exportDefinitions by their title
title?: string;