tridion-sites-extensions-api-docs

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

ItemsService class

Signature:

export declare class ItemsService

Methods

Method	Modifiers	Description
convertWebDavUrl({ webDavUrl, contextRepositoryUri, version, })	static	Constructs an item URI from a WebDav URL, plus optionally, a Context Repository URI and version number.
copy({ escapedItemId, escapedDestinationId, makeUnique, })	static	Copies a RepositoryLocalObject to the specified destination. 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>
create({ requestModel, autoCheckIn, })	static	Creates an object based on a specified request model and saves it to the database. For versioned items, a check-in is performed by default. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ApprovalStatus</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>Folder</li><li>Group</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><li>User</li></ul>
delete({ escapedItemId, })	static	Permanently deletes an item from the system. You can delete all versions of the item or only a specified version of the item.
getDefaultModel({ modelType, containerId, })	static	Gets a default model for the specified model type. The returned model can be used for item creation. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ApprovalStatus</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>Folder</li><li>Group</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><li>User</li></ul>
getItem({ escapedItemId, useDynamicVersion, })	static	Gets a single item by specifying the item URI. 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>Batch</li><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>Group</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>ProcessHistory</li><li>ProcessInstance</li><li>Publication</li><li>PublishTransaction</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionActivityDefinition</li><li>TridionProcessDefinition</li><li>User</li><li>WorkItem</li></ul>
getItems({ itemIds, useDynamicVersion, loadFullItems, })	static	Gets multiple items by specifying a list of item URIs. This operation returns an instance of ‘IdentifiableObjectDictionary’ type.
getItemsExtended({ itemIds, useDynamicVersion, loadFullItems, })	static	Gets a large number of items by specifying a list of item URIs in the body of the request. This operation returns an instance of ‘IdentifiableObjectDictionary’ type.
itemExists({ escapedItemId, })	static	Checks whether an item exists in the system based on its URI.
move({ escapedItemId, escapedDestinationId, })	static	Moves a RepositoryLocalObject from its current location to a new destination. 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>
update({ escapedItemId, requestModel, })	static	Updates an existing item with the specified item URI. 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>Batch</li><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>Group</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>ProcessHistory</li><li>ProcessInstance</li><li>Publication</li><li>PublishTransaction</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionActivityDefinition</li><li>TridionProcessDefinition</li><li>User</li><li>WorkItem</li></ul>
validatePage({ pageModel, })	static	Validates a Page according to the Page Schema that is used. This operation returns an instance of ‘ValidationError’ type.