Alfresco Index of Web Scripts Lifecycle '/draft_public_api'
Alfresco Community v3.2.0 (2039)
51 Web Scripts

Back to Web Scripts Home

Up to lifecycle /

Remove an authority from a group.
DELETE /alfresco/service/api/groups/{shortGroupName}/children/{fullAuthorityName}
---
Remove an authority (USER or GROUP) from a group. A user will not be deleted by this method.
You must have "administrator" privileges to alter a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/children.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/children.delete.desc.xml

Get the list of child authorities for a group.
GET /alfresco/service/api/groups/{shortName}/children?authorityType={authorityType?}
---
Get a list of the child authorities of a group. This contains both people and groups.
The authorityType parameter can be used to specify to return authorities of the given type. Valid values are GROUP and USER.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/children.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/children.get.desc.xml

Add group or user to a group
POST /alfresco/service/api/groups/{shortName}/children/{fullAuthorityName}
---
Add a group or user to a group. Will create a sub group if one does not already exist with the fullAuthorityName.
You must have "administrator" privileges to modify groups.
If the authority is for a group and doe not exist then it is created.
Returns Status_Created if a new group is created, else Status_OK. If Status_Created returns the new sub group, else returns the group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/children.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/children.post.desc.xml

Get the details of a group
GET /alfresco/service/api/groups/{shortName}
---
Get the details of a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/group.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/group.get.desc.xml

Update the details of a group
PUT /alfresco/service/api/groups/{shortName}
---
Update the details of a group.
you must have "administrator" privileges to change the name of a group.
The following properties may be updated.
displayName
The display name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/group.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/group.put.desc.xml

Delete a group.
DELETE /alfresco/service/api/groups/{shortName}
---
Delete a group and all its dependents.
You must have "administrator" privileges to delete a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/groups.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/groups.delete.desc.xml

List groups
GET /alfresco/service/api/groups?shortNameFilter={shortNameFilter?}&zone={zone?}
---
Search for groups.
Parameters
  • If the optional shortNameFilter parameter is set then returns those groups with a partial match on shortName. You can use the pattern matching characters * to match zero or more characters or ? to match one character.
  • If the optional zone parameter is set then only returns groups with are in the specified zone, else returns groups from all zones.

Returns an Array of groups in JSON format.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/groups.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/groups.get.desc.xml

Get the list of child authorities for a group.
GET /alfresco/service/api/groups/{shortName}/parents?level={level?}
---
Get a list of the parent authorities of a group.
The optional level attribute can be "ALL" in which case all parents are returned.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/parent.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/parent.get.desc.xml

Delete a root group.
DELETE /alfresco/service/api/rootgroups/{shortName}
---
Delete a root group and all its dependents.
You must have "administrator" privileges to delete a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/rootgroups.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/rootgroups.delete.desc.xml

List all root groups
GET /alfresco/service/api/rootgroups?shortNameFilter={shortNameFilter?}&zone={zone?}
---
List all root groups.
If the optional zone parameter is set to 'true' then returns root groups from the specified zone. If not specified will return groups from all zones.
If the optional shortNameFilter parameter is set then returns those root groups with a partial match on shortName. The shortname filter can contain the wild card characters * and ? but these must be url encoded for this script.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/rootgroups.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/rootgroups.get.desc.xml

Add a rootgroup
POST /alfresco/service/api/rootgroups/{shortName}
---
Add a root group.
You must have "administrator" privileges to add a root group.
Returns STATUS_CREATED if a new group is created.
If the group already exists returns BAD_REQUEST. The following properties may be specified for the new root group.
displayName
The display name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/rootgroups.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/rootgroups.post.desc.xml

List Invitations
GET /alfresco/service/api/invitations?inviteeUserName={inviteeUserName?}&invitationType={invitationType?}&resourceType={resourceType?}
---
Get a collecton of a invitations.
With no parameters, returns all open invitations (which could be a large number).
With inviteeUserName, returns all open invitations for this invitee.
With invitationType, returns invitations of the specified type (Either NOMINATED or MODERATED).
With resourceType, returns invitations of the specified type (WEB_SITE only at the moment).
Returns a JSON array of Invitations.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/invitation/invitations.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/invitation/invitations.get.desc.xml

Cancel invitation
DELETE /alfresco/service/api/sites/{shortname}/invitations/{invitationId}
---
Cancel an open invitation.
Canceling an invitation immediatly stops the invitation, it is different to rejecting an invitation which will result in the invitation workflow continuing to a normal but rejected conclusion. In particular the approver or invitee are not notified if an invitation is canceled.
Only a site manager may cancel an nominated invitation.
A site manager or the invitee may cancel a moderated invitation.
Returns 200, STATUS_OK on success.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitation.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitation.delete.desc.xml

Get Invitation
GET /alfresco/service/api/sites/{shortname}/invitations/{inviteId}
---
Get a single web site invitation.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitation.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitation.get.desc.xml

Create invitation for web site
POST /alfresco/service/api/sites/{shortname}/invitations
---
Create a new invitation for this web site.
For a Nominated Invitation, where an existing site member nominates someone else who is possibly not yet an alfresco user to become a member of this web site.
For an existing user, the invitee is identified by inviteeUserName. For a user who does not have a userName a new account will be generated based upon inviteeFirstName, inviteeLastName and inviteeEmail
if inviteeUserName is specified then inviteeFirstName, inviteeLastName and inviteeEmail are ignored.
invitationType
mandatory - "NOMINATED"
inviteeFirstName
optional,
inviteeLastName
optional,
inviteeEmail
optional,
inviteeUserName
optional
serverPath
acceptURL
rejectURL
inviteeRoleName
mandatory what role to be given on this web site

For a Moderated Invitation, where an existing user wants to be made a member of a moderated web site.
invitationType
mandatory - "MODERATED"
inviteeUserName
optional who wants to be invited to this web site?
inviteeComments
mandatory (but can be blank) why do they want membership to this site ?
inviteeRoleName
mandatory what role to be given on this web site

Returns HTTPStatus.Created (201) if an invitation is created.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitation.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitation.post.desc.xml

List Invitations
GET /alfresco/service/api/sites/{shortname}/invitations?inviteeUserName={inviteeUserName?}&invitationType={invitationType?}
---
Get a collecton of a site web invitations.
With no parameters, returns all open invitations for this web site.
With inviteeUserName, returns all open invitations for this web site and invitee.
With invitationType, returns all open invitations of the specified type (Either NOMINATED or MODERATED).
Returns a JSON element
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitations.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitations.get.desc.xml

Delete Web Site Membership
DELETE /alfresco/service/api/sites/{shortname}/memberships/{authorityname}
---
Delete membership from a web site.
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/membership.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.delete.desc.xml

Get Web Site Membership
GET /alfresco/service/api/sites/{shortname}/memberships/{authorityname}
---
Get the membership details for a user or group
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership.
Returns a membership or Status.NOT_FOUND(404)
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/membership.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.get.desc.xml

Update Web Site Membership
PUT /alfresco/service/api/sites/{shortname}/memberships/{authorityname}
---
Update the membership role for a user or group
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership.
Required parameters,
role, mandatory String, the new role name for this membership.
person object, with userName property
OR group object, with fullName property
OR authority object, with fullName property
Returns: The new authority.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/membership.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.put.desc.xml

List Web Site Memberships
GET /alfresco/service/api/sites/{shortname}/memberships?nf={namefilter?}&rf={rolefilter?}&size={pagesize?}&pos={position?}&authorityType={authorityType?}
---
Get a colleciton of a Web Site memberships.
'shortname' is the shortname of the web site
Parameters:
  • nf, Optional, namefilter
  • rf, Optional, rolefilter
  • size, Optional, page size
  • authorityType, Optional, returns either GROUP or USER authorities. If not specified returns all authorities.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/memberships.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/memberships.get.desc.xml

Add Web Site Membership
POST /alfresco/service/api/sites/{shortname}/memberships
---
Adds a new membership to the web site
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership. Required parameters,
role, mandatory String, the new role name for this membership.
person object, with userName property
OR group object, with fullName property
OR authority object, with fullName property
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/memberships.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/memberships.post.desc.xml

List Potential Web Site Memberss
GET /alfresco/service/api/sites/{shortname}/potentialmembers?filter={filter?}&maxResults={maxResults?}&authorityType={authorityType?}
---
Get a colleciton of People and/or Groups who are not yet Site members.
'shortname' is the shortname of the web site
Parameters:
  • filter, Optional, filter
  • maxResults, Optional, maximum resultset to return
  • authorityType, Optional, returns either GROUP or USER authorities. If not specified returns all authorities.
  • zone, Optional, specifies group zone if including groups in query.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/potentialmembers.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/potentialmembers.get.desc.xml

Get Web Site
GET /alfresco/service/api/sites/{shortname}
---
Get the details of a web site. Returns 200, STATUS_OK on success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/site.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.get.desc.xml

Update Web Site
PUT /alfresco/service/api/sites/{shortname}
---
Update the details of a site. The following properties may be updated.
title
the title of the web site
description
the description for the web site
visibility
the site visibility, one of (PUBLIC,MODERATED,PRIVATE)
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/site.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.put.desc.xml

Create Web Site
POST /alfresco/service/api/sites
---
Creates a new site based on the site preset and details provided.
The following properties may be set.
shortName
the shortName of the web site, mandatory, must be unique
sitePreset
the sitePreset
title
the title of the web site
description
the description for the web site
visibility
the site visibility, one of (PUBLIC,MODERATED,PRIVATE), defaults to PUBLIC
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/sites.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.post.desc.xml

Content Write (setContent)
PUT /alfresco/service/api/node/content{property}/{store_type}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/path/content{property}/{store_type}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/avmpath/content{property}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}?overwriteFlag={overwriteFlag?}
---
TODO
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:text
Lifecycle:draft_public_api
Id:org/alfresco/repository/store/content.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/content.put.desc.xml

Get Node Tags
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/tags
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/tags
---
Get all the tags for a node
Returns STATUS_OK (200)
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/node.tags.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/node.tags.get.desc.xml

Add tag
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/tags
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/tags
---
Add one or more tags to the node
Input:
(mandatory) array of String
Returns the array of tags
Return STATUS_OK (200).
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/node.tags.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/node.tags.post.desc.xml

List all tags
GET /alfresco/service/api/tags/{store_type}/{store_id}?tf={tag_filter?}
---
Get the currently available tags for the specified store.
tag_filter
The optional tag filter limits the returned tags to those containing the filter.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/tags.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tags.get.desc.xml

Get nodes for tag
GET /alfresco/service/api/tags/{store_type}/{store_id}/{tag}/nodes
---
Get the nodes which have a given tag
Return content
Array of
  • nodeRef
  • url

Return status: STATUS_OK, 200
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/tags.nodes.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tags.nodes.get.desc.xml

Tagscope tags
GET /alfresco/service/api/tagscopes/node/{store_type}/{store_id}/{id}/tags
GET /alfresco/service/api/tagscopes/site/{site}/tags
GET /alfresco/service/api/tagscopes/site/{site}/{container}/tags
---
Get all tags of the nearest available tagscope
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/tagscope-tags.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tagscope-tags.get.desc.xml

Delete Web Project Membership
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships/{username}
---
Delete (uninvite) the membership for a user.
Please note that the user's sandboxes are deleted even if they have unsubmitted content.
Returns 200, STATUS_OK on success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/membership.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/membership.delete.desc.xml

Get Membership
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships/{username}
---
Get the webproject membership details for a user
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/membership.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/membership.get.desc.xml

List Memberships
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships
---
Get the collection of a web project memberships for a web project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/memberships.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/memberships.get.desc.xml

Add user to web project
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships
---
Adds a new membership to the web project. After calling this method the user will be able to access the specified web project.
Input
role
The role that the person should have
person
Details of the person.

Returns 200, STATUS_OK
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/memberships.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/memberships.post.desc.xml

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

Delete Sandbox
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxRef}
---
Deletes a WCM sandbox and all its contents.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandbox.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.delete.desc.xml

Get Web Project Sandbox
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}
---
Get details of single sandbox of a web project. Return 
 data: sandboxref name creator createdDate.iso8601 storeNames" : [ ] isAuthorSandbox isStagingSandbox url
Returns STATUS_OK, 200
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandbox.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.get.desc.xml

Create user sandbox
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes
---
Create (POST) a new author sandbox for a user.
The following fields are required in the body of the request:
  • userName

Returns STATUS_CREATED,201 on success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandbox.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.post.desc.xml

Web Project Sandboxes
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes?userName={userName?}
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes
---
Get a collection of a web project sandboxes.
If userName is specified then returns the sandboxes for the specified user.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandboxes.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandboxes.get.desc.xml

Delete Web Project
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}
---
Delete a single WCM web project and its contents,
webprojectref specifies which project to delete and will have been returned by a prior call to get, create or list web project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.delete.desc.xml

Get Web Project
GET /alfresco/service/api/wcm/webprojects/{webprojectref}
---
Get a single WCM web project in JSON format.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.get.desc.xml

Create Web Project
POST /alfresco/service/api/wcm/webprojects
---
Create (POST) a single WCM web project.
The following fields are required in the body of the request:
name
Human readable name for the web project.
title
Human readable title for the web project.
dnsName
The name of the web project which will become part of the URL. Should be short and unique.

The following fields are optional:
description
description about the web project

Returns 201, STATUS_CREATED on success. The body of the return will contain the new Web Project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.post.desc.xml

Update Web Project
PUT /alfresco/service/api/wcm/webprojects/{webprojectref}
---
Update a single WCM web project
webprojectref is the unique reference returned by an earlier call to list, get or create web project
The following fields are may be updated in the body of the request:
  • name
  • title
  • description
  • isTemplate

      • Returns 200 STATUS_OK, the body of the return will contain the updated web project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.put.desc.xml

Web Projects
GET /alfresco/service/api/wcm/webprojects?userName={userName?}
GET /alfresco/service/api/wcm/webprojects
---
Get a list of the WCM Web projects.
userName is an optional argument that if specified then only those web projects for the specified user are returned else all web projects are returned.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webprojects.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webprojects.get.desc.xml