 |
Index of Web Scripts URI '/api/node/{store_type}/{store_id}/{id}' |
| Alfresco Community v3.2.0 (2039) |
| 4 Web Scripts |
| Back to Web Scripts Home |
| Up to uri /api/node/{store_type}/{store_id} |
Delete item (deleteObject)
| DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}?includeChildren={includeChildren?} |
| DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}?includeChildren={includeChildren?} |
| Description: | Deletes specified object Inputs: ID objectId Notes: If the object is a Folder with at least one child, throw ConstraintViolationException. If the object is the Root Folder, throw OperationNotSupportedException. When a filed object is deleted, it is removed from all folders it is filed in. This service deletes a specific version of a document object. To delete all versions, use deleteAllVersions() Deletion of a private working copy (checked out version) is the same as to cancel checkout. |
| Authentication: | user |
| Transaction: | required |
| Format Style: | any |
| Default Format: | atomentry |
| Id: | org/alfresco/repository/store/item.delete |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.delete.desc.xml |
Retrieve properties (getProperties)
| Description: | Returns the properties of an object, and optionally the operations that the user is allowed to perform on the object Inputs: ID objectId (Optional) Enum returnVersion: This (Default), Latest, LatestMajor (Optional) String filter: Filter for properties to be returned (Optional) Boolean includeAllowableActions: False (default) (Optional) Enum includeRelationships: none (default), source, target, both Outputs: Collection propertyCollection Collection allowableActionCollection Notes: If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for the object as part of the output. "IncludeRelationships" indicates whether relationships are also returned for the 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. Does not return the content-stream of a document PropertyCollection includes changeToken (if applicable to repository) |
| Authentication: | guest |
| Transaction: | required |
| Format Style: | argument |
| Default Format: | atomentry |
| Id: | org/alfresco/repository/store/item.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.get.desc.xml |
Update properties (updateProperties)
| PATCH /alfresco/service/api/node/{store_type}/{store_id}/{id} |
| PATCH /alfresco/service/api/path/{store_type}/{store_id}/{id} |
| Description: | This service updates properties of the specified object. As per the data model, content-streams are not properties Inputs: ID objectId (Optional) String changeToken Collection propertyCollection - Subset list of Properties to update Outputs: ID objectId Notes: Preserves the ID of the object Subset of properties: Properties not specified in this list are not changed To remove a property, specify property with no value If an attempt is made to update a read-only property, throw ConstraintViolationException. If a ChangeToken is provided by the repository when the object is retrieved, the change token MUST be included as-is when calling updateProperties. For Multi-Value properties, the whole list of values MUST be provided on every update. Use getAllowableActions to identify whether older version specified by ID is updatable. If this is a private working copy, some repositories may not support updates. Because repositories MAY automatically create new Document Versions on a user’s behalf, the objectId returned may not match the one provided as an input to this method. |
| Authentication: | user |
| Transaction: | required |
| Format Style: | argument |
| Default Format: | atomentry |
| Id: | org/alfresco/repository/store/item.patch |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.patch.desc.xml |
Update properties (updateProperties)
| PUT /alfresco/service/api/node/{store_type}/{store_id}/{id} |
| PUT /alfresco/service/api/path/{store_type}/{store_id}/{id} |
| Description: | This service updates properties of the specified object. As per the data model, content-streams are not properties Inputs: ID objectId (Optional) String changeToken Collection propertyCollection - Subset list of Properties to update Outputs: ID objectId Notes: Preserves the ID of the object Subset of properties: Properties not specified in this list are not changed To remove a property, specify property with no value If an attempt is made to update a read-only property, throw ConstraintViolationException. If a ChangeToken is provided by the repository when the object is retrieved, the change token MUST be included as-is when calling updateProperties. For Multi-Value properties, the whole list of values MUST be provided on every update. Use getAllowableActions to identify whether older version specified by ID is updatable. If this is a private working copy, some repositories may not support updates. Because repositories MAY automatically create new Document Versions on a user’s behalf, the objectId returned may not match the one provided as an input to this method. |
| Authentication: | user |
| Transaction: | required |
| Format Style: | argument |
| Default Format: | atomentry |
| Id: | org/alfresco/repository/store/item.put |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.put.desc.xml |