 |
Index of Web Scripts URI '/api/checkedout' |
| Alfresco Community v3.2.0 (2039) |
| 2 Web Scripts |
| Back to Web Scripts Home |
| Up to uri /api |
Checked-out Documents (getCheckedoutDocuments)
| Description: | Gets the list of documents that are checked out that the user has access to. Most likely this will be the set of documents checked out by the user. Content-streams are not returned. Inputs: (Optional) ID folderId (Optional) String 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 (Default) Outputs: Result set specified by Filter Bool hasMoreItems Notes: The documents will be returned in a repository-specific order. The repository may include checked-out objects that the calling user has access to, but did not check out. If folderId is specified, then the results MUST include only the children of that folder, NOT other descendants of the folder nor documents outside this tree. If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each document 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: | user |
| Transaction: | required |
| Format Style: | any |
| Default Format: | atomfeed |
| Id: | org/alfresco/repository/store/checkedout.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/checkedout.get.desc.xml |
Checkout a document (checkOut)
| POST /alfresco/service/api/checkedout |
| Description: | Create a private working copy of the object, copies the metadata and optionally content. It is up to the repository to determine if updates to the current version (not PWC) and prior versions are allowed if checked-out. Inputs: ID documentId: ObjectID of Doc Version to checkout Outputs: ID documentId: ObjectID of Private Working Copy Bool contentCopied Notes: It is repository-specific to determine the scope of visibility to the private working copy. Other users not in the scope of checkout will see the public (pre-checkout) version while those in scope will be able to work on the checked-out version. Copying content on checkout or not is repository-specific. CheckOut() may remove update permission on prior versions. CheckOut() on a non-document object will throw OperationNotSupportedException. Some repositories may not support updating of private working copies and the updates MUST be supplied via checkIn(). |
| Authentication: | user |
| Transaction: | required |
| Format Style: | any |
| Default Format: | atomentry |
| Id: | org/alfresco/repository/store/checkedout.post |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/checkedout.post.desc.xml |