 |
Index of Web Scripts URI '/api/path/{store_type}/{store_id}/{id}/children' |
| Alfresco Community v3.2.0 (2039) |
| 2 Web Scripts |
| Back to Web Scripts Home |
| Up to uri /api/path/{store_type}/{store_id}/{id} |
Retrieve list of children (getChildren)
| Description: | Gets the list of child objects contained in the specified folder. Only the filter-selected properties associated with each object are returned. The content-streams of documents are 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) String filter: Filter specifying which properties to return. (Optional) Boolean includeAllowableActions: False (default) (Optional) Enum includeRelationships: none (default), source, target, both (Optional) int maxItems: 0 = Repository-default number of items (Default) (Optional) int skipCount: 0 = start (Default) (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 child object in the specified folder If maxItems > 0, Bool hasMoreItems Notes: Between invocations the order of the results may change due to repository state changing, i.e. skipCount might not show objects or more likely show an object twice (bottom of first page and top of second) when an object is added to the top of the list. Ordering is repository-specific except the ordering MUST remain consistent across invocations, provided that the repository state has not changed. When returning the results of a call where the caller specified “Any” type, the repository SHOULD return 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 child 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. If no “maxItems” value is provided, then the Repository will determine an appropriate number of items to return. How the Repository determines this value is repository-specific and opaque to CMIS. |
| Authentication: | guest |
| Transaction: | required |
| Format Style: | argument |
| Default Format: | atomfeed |
| Id: | org/alfresco/repository/store/children.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/children.get.desc.xml |
Create folder or document (createDocument, createFolder)
| POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/children |
| POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/children |
| 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/children.post |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/children.post.desc.xml |