IWorkspaceCatalogFactoryOptions
Configuration options for querying catalog items
export interface IWorkspaceCatalogFactoryOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) Get catalog items from a specific dataset | |||
ObjRef[] | Get catalog items that don’t have reference to specific tags Use this to obtain catalog items that are not included in specific group(s). | ||
string[] | (Optional) Optional list of additional date dataset granularities that must be added by backend to the ones returned by default. Default: undefined | ||
ObjRef[] | Get catalog items that have reference to specific tags. This is commonly used to obtain catalog items from specific group(s). | ||
boolean | (Optional) Should catalog fetch groups? Default: true | ||
boolean | (Optional) Should catalog ask the backend for object-level permissions of the loaded items? Only measures carry them at the moment. Default: false | ||
number | (Optional) Page size of items to load. Default: 250 | ||
boolean | (Optional) When true, get only production ready catalog items. When false, get only non-production ready catalog items. Otherwise, return both. Default: undefined | ||
string | (Optional) Search for catalog items by title or identifier. | ||
Get catalog items of specific types (attribute, measure, fact, dateDataset, attributeHierarchy or computedAttribute) Default: DefaultWorkspaceCatalogTypes |
Property details
IWorkspaceCatalogFactoryOptions.datasetproperty
Get catalog items from a specific dataset
dataset?: ObjRef;
IWorkspaceCatalogFactoryOptions.excludeTagsproperty
Get catalog items that don’t have reference to specific tags Use this to obtain catalog items that are not included in specific group(s).
excludeTags: ObjRef[];
IWorkspaceCatalogFactoryOptions.includeDateGranularitiesproperty
Optional list of additional date dataset granularities that must be added by backend to the ones returned by default. Default: undefined
includeDateGranularities?: string[];
IWorkspaceCatalogFactoryOptions.includeTagsproperty
Get catalog items that have reference to specific tags. This is commonly used to obtain catalog items from specific group(s).
includeTags: ObjRef[];
IWorkspaceCatalogFactoryOptions.loadGroupsproperty
Should catalog fetch groups? Default: true
loadGroups?: boolean;
IWorkspaceCatalogFactoryOptions.loadPermissionsproperty
Should catalog ask the backend for object-level permissions of the loaded items? Only measures carry them at the moment. Default: false
loadPermissions?: boolean;
IWorkspaceCatalogFactoryOptions.pageSizeproperty
Page size of items to load. Default: 250
pageSize?: number;
IWorkspaceCatalogFactoryOptions.productionproperty
When true, get only production ready catalog items. When false, get only non-production ready catalog items. Otherwise, return both. Default: undefined
production?: boolean;
IWorkspaceCatalogFactoryOptions.searchproperty
Search for catalog items by title or identifier.
search?: string;
IWorkspaceCatalogFactoryOptions.typesproperty
Get catalog items of specific types (attribute, measure, fact, dateDataset, attributeHierarchy or computedAttribute) Default: DefaultWorkspaceCatalogTypes
types: CatalogItemType[];