Alfresco Index of Web Scripts Family '/WCM/Asset'
Alfresco Community v3.2.0 (2039)
7 Web Scripts

Back to Web Scripts Home

Up to family /WCM

Delete the specified asset.
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Delete the specified asset.
If the optional webApp argument is specified then the path is relative to the webapp e.g. /index.htm
If webApp is not specified then the path is will be absolute e.g. /www/avm_webapps/ROOT/index.htm
Returns STATUS_OK(200) for success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.delete.desc.xml

Get the details of the specified asset within the specified web project and sandbox.
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Get the details of the specified asset.
If the asset is a folder, includes the children of that folder.
If the asset is a file, gives the size of the file.
If the optional webApp argument is specified then returns the asset relative to that web app e.g. /index.htm
If webApp is not specified then the path is will be absolute e.g. /www/avm_webapps/ROOT/index.htm
Return STATUS_OK, 200
Output - The asset in JSON format data: path, the full path of the asset. name, the name of the asset creator createdDate, iso8601, modifier modifiedDate, iso8601, isLocked, boolean isFile, boolean isFolder, boolean isDeleted, boolean children, JSON array, only present for folder fileSize, numeric, only present for files
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.get.desc.xml

Create a new WCM asset.
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Create a new WCM Asset in the specified path and sandbox.
If the optional webApp argument is specified then the path is relative to the webapp.
If webApp is not specified then the path is will be absolute e.g. /www/avm_webapps/ROOT
JSON Input values
name
mandatory name of this asset
type
mandatory "file" or "folder"
content/dt>
optional, string content of the new file, this is a convenience method, normally content is added via the file upload which gives greater control over the content.
JSON Return value: 
 data:The newly created asset in JSON format.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.post.desc.xml

Update a WCM asset.
PUT /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
PUT /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Update a WCM Asset, you can rename or move an asset.
JSON Input properties
name
optional rename this file or folder to this new name
path
optional move this file or folder to this path. The destination folder must already exist.

JSON Return data:
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.put.desc.xml

Get modified assets within the specified sandbox.
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/modified
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/modified?webApp={webApp?}
---
Get the modified (added, deleted, updated) details of an asset within an author's sandbox.
If a folder has been added then only the folders's properties are returned (not folder plus assets within that new folder).
If the optional webApp argument is specified then returns the modified assets within that web app.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/modified.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/modified.get.desc.xml

Revert modified assets within the specified author sandbox.
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/reverter
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/reverter?webApp={webApp?}
---
Revert the modified (added, deleted, updated) assets contained within an author's sandbox.
If the optional webApp argument is specified then reverts the modified assets within that web app.
JSON data fileds
all
boolean is this submit all? (optional)
assets
array, of JSON objects containing a path property (optional). If the "all" option is true then this parameter is ignored
paths
array, of String paths. If the "all" option is true then this parameter is ignored
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/revert.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/revert.post.desc.xml

Submit modified assets from within the specified author sandbox.
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/submitter
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/submitter?webApp={webApp?}
---
Submit the modified (added, deleted, updated) assets contained within an author's sandbox.
If the optional webApp argument is specified then submits the modified assets within that web app.
JSON data fileds
label
string label for this submission (mandatory)
comment
string comment for this submission (mandatory)
all
boolean is this submit all? (optional)
assets
array, of JSON objects containing a path property (optional). If the "all" option is true then this parameter is ignored
paths
array, of String paths. If the "all" option is true then this parameter is ignored
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/submit.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/submit.post.desc.xml