Alfresco Index of Web Scripts Package '/org/alfresco/repository/site'
Alfresco Community v3.2.0 (2039)
6 Web Scripts

Back to Web Scripts Home

Up to package /org/alfresco/repository

/org/alfresco/repository/site/invitation
/org/alfresco/repository/site/membership
/org/alfresco/repository/site/roles

Site
DELETE /alfresco/service/api/sites/{shortname}
Description:Delete the details of a site.
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/site/site.delete
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.delete.desc.xml

Get Web Site
GET /alfresco/service/api/sites/{shortname}
Description: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
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.get.desc.xml

Update Web Site
PUT /alfresco/service/api/sites/{shortname}
Description: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
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.put.desc.xml

Sites
GET /alfresco/service/api/sites?nf={namefilter?}&spf={sitepresetfilter?}&size={pagesize?}&pos={position?}
Description:Get a colleciton of the sites in the repository. The collection can be filtered by name and/or site preset.
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/site/sites.get
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.get.desc.xml

Create Web Site
POST /alfresco/service/api/sites
Description: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
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.post.desc.xml

SitesQuery
POST /alfresco/service/api/sites/query
Description:Queries the collection of sites.
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/site/sites.query.post
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.query.post.desc.xml