tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > ListsService

ListsService class

Signature:

export declare class ListsService

Methods

Method	Modifiers	Description
getCategories({ escapedPublicationId, })	static	Gets a list of Categories related to the specified Publication. This operation returns an instance of ‘Category’ type or one of the following inherited types:<ul class="model-list"><li>ExternalCategory</li></ul>
getDependencyGraph({ escapedItemId, direction, contextRepositoryId, rloItemTypes, includeContainers, resultLimit, details, })	static	Gets a dependency graph for the specified item. This operation returns an instance of ‘DependencyGraphNode’ type.
getGroups({ inPublicationId, includeEveryone, search, searchMode, })	static	Gets a list of Groups. This operation returns an instance of ‘Group’ type.
getKeywords({ escapedItemId, })	static	Gets a list of Keywords contained in the specified Category or parent Keyword. This operation returns an instance of ‘Keyword’ type or one of the following inherited types:<ul class="model-list"><li>ExternalKeyword</li></ul>
getLockedItems({ forAllUsers, lockUserId, lockFilter, lockResult, maxResults, })	static	Gets a list of locked items (either versioned items or organizational items). This operation returns an instance of ‘RepositoryLocalObject’ type, as implemented by one of the following:<ul class="model-list"><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalContainer</li><li>ExternalKeyword</li><li>Folder</li><li>Keyword</li><li>Page</li><li>PageTemplate</li><li>ResolvedBundle</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TemplateBuildingBlock</li><li>TridionProcessDefinition</li></ul>
getOrganizationalStructureTree({ escapedItemId, includeAllPublications, includeChildrenOnEveryLevel, groupCategoriesAndKeywords, groupBusinessProcessTypes, useDynamicVersion, })	static
getPublications()	static	<p>Gets a list of all Publications. This operation returns an instance of ‘Publication’ type.</p><p>This operation returns a limited set of properties compared to other list operations. To get a full set of properties, read each Publication separately.</p>
getPublicationTypes()	static	Gets a list of Publication Types. This operation returns an instance of ‘PublicationType’ type.
getPublishableChildPublications({ escapedPublicationId, })	static	Gets a list of all child Publications of the specified Parent publication, where the Business Process Type settings are the same as those of the parent Publication. This operation returns an instance of ‘Publication’ type.
getPublishableTargetTypes({ escapedBusinessProcessTypeId, })	static	Gets a list of Target Types for a specified Business Process Type. This operation returns an instance of ‘TargetType’ type.
getTargetTypes()	static	Gets a list of Target Types. This operation returns an instance of ‘TargetType’ type.
getTaxonomy({ escapedCategoryId, includeAlternativeLabels, maxNodes, })	static	Gets a full taxonomy for a specified Category. This operation returns an instance of ‘TaxonomyNode’ type.
getUsedBy({ escapedItemId, onlyLatestVersions, useDynamicVersion, includeLocalCopies, details, })	static	Gets a list of items that use a specified item. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ActivityHistory</li><li>ActivityInstance</li><li>ApprovalStatus</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalKeyword</li><li>Folder</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>Publication</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionProcessDefinition</li></ul>
getUsers({ predefined, includeDisabled, search, searchMode, })	static	Gets a list of Users. This operation returns an instance of ‘User’ type or one of the following inherited types:<ul class="model-list"><li>AccessToken</li></ul>
getUses({ escapedItemId, includeBlueprintParentItem, useDynamicVersion, details, })	static	Gets a list of items that are used by a specified item. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ActivityHistory</li><li>ActivityInstance</li><li>ApprovalStatus</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalKeyword</li><li>Folder</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>Publication</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionProcessDefinition</li></ul>