 |
Index of Web Scripts URI '/api/path/{store_type}/{store_id}/{id}/descendants' |
| Alfresco Community v3.2.0 (2039) |
| 3 Web Scripts |
| Back to Web Scripts Home |
| Up to uri /api/path/{store_type}/{store_id}/{id} |
Delete tree (deleteTree)
| Description: | Deletes the tree rooted at specified folder (including that folder) Inputs: ID folderId Enum unfileNonfolderObjects: o Unfile – unfile all non-folder objects from folders in this tree. They may remain filed in other folders, or may become unfiled. o DeleteSingleFiled – delete non-folder objects filed only in this tree, and unfile the others so they remain filed in other folders. o Delete – delete all non-folder objects in this tree (Default) (Optional) Bool continueOnFailure: False (Default) Outputs: Collection failedToDelete - List of object IDs that failed to delete (if continueOnFailure is FALSE, then single object ID) Notes: If a non-folder object is removed from the last folder it is filed in, it can continue to survive outside of the folder structure if the repository supports the “Unfiling” capabiliity. If the specified folder is the Root Folder, throw OperationNotSupportedException. If unfiling is not supported, throw OperationNotSupportedException if deleteTree is called with Unfile. For repositories that support version-specific filing, this may delete some versions of a document but not necessarily all versions. For repositories that do not support version-specific filing, if a document is to be deleted, all versions are deleted. This is not transactional. o However, if DeleteSingleFiled is chosen, then having the objects unfiled is not sufficient if some objects fail to delete. The user MUST be able to re-issue command (recover) from the error by using the same tree. Does not specify the order in which delete will happen o However, any objects that are not deleted (e.g. because a previous object failed to delete), they MUST remain valid CMIS objects (including any applicable filing constraint for each object). |
| Authentication: | user |
| Transaction: | required |
| Format Style: | any |
| Default Format: | atomfeed |
| Id: | org/alfresco/repository/store/descendants.delete |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.delete.desc.xml |
Retrieve tree of descendants (getDescendants)
| Description: | Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder. Only the filter-selected properties associated with each object are returned. The content-stream is not returned. For paging through the children (depth of 1) only use getChildren. For returning a tree of objects of a certain depth, use getDescendants. For a repository that supports version-specific filing, this will return the version of the documents in the folder specified by the user filing the documents into the folder. Otherwise, the latest version of the documents will be returned. Inputs: ID folderId (Optional) Enum type: Documents, Folders, Policies, Any (default) (Optional) Int depth: 1 this folder only (Default), … N folders deep, -1 for all levels (Optional) String filter: Filter specifying which properties to return. (Optional) Boolean includeAllowableActions: False (default) (Optional) Enum includeRelationships: none (default), source, target, both (Optional) String orderBy: must be a valid ORDER BY clause from the query grammer excluding ‘ORDER BY’. Example ‘name DESC’. Outputs: Result set specified by Filter of each descendant object in the specified folder This result set will nest the contained objects Notes: The ordering and tree walk algorithm is repository-specific, but SHOULD be consistent. This method will return all objects of the specified type in the specified depth. If no type is specified, then objects of all types will be returned. When returning the results of a call where the caller specified “Any” type, the repository SHOULD return, at each nesting level, all folder objects first followed by other objects. If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each descendant object as part of the output. "IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned. |
| Authentication: | guest |
| Transaction: | required |
| Format Style: | argument |
| Default Format: | atomfeed |
| Id: | org/alfresco/repository/store/descendants.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.get.desc.xml |
Create folder or document (createDocument, createFolder)
| POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants |
| POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/descendants |
| Description: | Creates a document object of the specified type, and optionally adds the document to a folder Inputs: ID typeId: Document type Collection properties (Optional) ID folderId: Parent folder for this new document (Optional) ContentStream contentStream (Optional) Enum versioningState: CheckedOut, CheckedInMinor, CheckedInMajor (Default) Outputs: ID objectId: Id of the created document object The versioningState input is used to create a document in a checked-out state, or as a checked-in minor version, or as a checked-in major version. If created in a checked-out state, the object is a PWC and there is no corresponding "checked out document". (See the "Versioning" section.) If the Document’s Object Type does not allow content-stream and a content-stream is provided, or if content-stream is required and a content-stream is not provided, throw ConstraintViolationException. If a Folder is specified, and the Document’s Object Type is not one of the “Allowed_Child_Object_Types” for this Folder, throw ConstraintViolationException. If unfiling is not supported and a Folder is not specified, throw FolderNotValidException. Repositories MAY reject the createDocument request (by throwing ConstaintViolationException) if any of the Required properties specified in the Document’s Object Type are not set. However, iF the repository does NOT reject the createDocument request in this case, the repository MUST leave the newly-created Document in a checked-out state, and MUST ensure that all required properties are set before the Document is checked in. Creates a folder object of the specified type Inputs: ID typeId: Folder type Collection properties ID folderId: Parent folder for this new folder Outputs: ID objectId: Id of the created folder object Notes: If the to-be-created Folder’s Object Type is not one of the “Allowed_Child_Object_Types” for the parent Folder, throw ConstraintViolationException. Root folder can not be created using this service. |
| Authentication: | user |
| Transaction: | required |
| Format Style: | any |
| Default Format: | atomentry |
| Id: | org/alfresco/repository/store/descendants.post |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.post.desc.xml |