(approve-site-membership-request ticket site-id invitee-id body & [opts])Approve a site membership request.
More info here.
Approve a site membership request.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/approveSiteMembershipRequest).
(create-group-site-membership ticket site-id body)(create-group-site-membership ticket site-id body query-params & [opts])Creates a site membership for group group-id on site site-id.
You can set the role to one of four types:
More info here.
Creates a site membership for group `group-id` on site `site-id`. You can set the **role** to one of four types: - SiteConsumer - SiteCollaborator - SiteContributor - SiteManager More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/createSiteGroupMembership).
(create-person-site-membership-requests ticket person-id body)(create-person-site-membership-requests ticket
person-id
body
query-params
&
[opts])Create a site membership request for yourself on the site with the identifier of id, specified in the body. The result of the request differs depending on the type of site.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Create a site membership request for yourself on the site with the identifier of id, specified in the `body`. The result of the request differs depending on the type of site. - For a **public** site, you join the site immediately as a SiteConsumer. - For a **moderated** site, your request is added to the site membership request list. The request waits for approval from the Site Manager. - You cannot request membership of a private site. Members are invited by the site administrator. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/createSiteMembershipRequestForPerson).
(create-site ticket body)(create-site ticket body query-params & [opts])Creates a default site with the given details. Unless explicitly specified, the site id will be generated from the site title.
The site id must be unique and only contain alphanumeric and/or dash characters.
Note: the id of a site cannot be updated once the site has been created.
More info here.
Creates a default site with the given details. Unless explicitly specified, the site id will be generated from the site title. The site id must be unique and only contain alphanumeric and/or dash characters.\ **Note:** the id of a site cannot be updated once the site has been created.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/createSite).
(create-site-membership ticket site-id body)(create-site-membership ticket site-id body query-params & [opts])Creates a site membership for person person-id on site site-id.
You can set the role to one of four types:
More info here.
Creates a site membership for person `person-id` on site `site-id`. You can set the **role** to one of four types: - SiteConsumer - SiteCollaborator - SiteContributor - SiteManager More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/createSiteMembership).
(delete-group-site-membership ticket site-id group-id & [opts])Deletes group group-id as a member of site site-id.
More info here.
Deletes group `group-id` as a member of site `site-id`. More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/deleteSiteGroupMembership).
(delete-person-site-membership ticket person-id site-id & [opts])Deletes person person-id as a member of site site-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Deletes person `person-id` as a member of site `site-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/deleteSiteMembershipForPerson).
(delete-person-site-membership-request ticket person-id site-id & [opts])Deletes the site membership request to site site-id for person person-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Deletes the site membership request to site `site-id` for person `person-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/deleteSiteMembershipRequestForPerson).
(delete-site ticket site-id)(delete-site ticket site-id query-params & [opts])Deletes the site with site-id.
More info here.
Deletes the site with `site-id`.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/deleteSite).
(delete-site-membership ticket site-id person-id & [opts])Deletes person person-id as a member of site site-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Deletes person `person-id` as a member of site `site-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/deleteSiteMembership).
(get-group-site-membership ticket site-id group-id)(get-group-site-membership ticket site-id group-id query-params & [opts])Gets site membership information for group group-id on site site-id.
More info here.
Gets site membership information for group `group-id` on site `site-id`.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/getSiteGroupMembership).
(get-person-site-membership ticket person-id site-id & [opts])Gets site membership information for person person-id on site site-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Gets site membership information for person `person-id` on site `site-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/getSiteMembershipForPerson).
(get-person-site-membership-request ticket person-id site-id)(get-person-site-membership-request ticket
person-id
site-id
query-params
&
[opts])Gets the site membership request for site site-id for person person-id, if one exists.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Gets the site membership request for site `site-id` for person `person-id`, if one exists. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/getSiteMembershipRequestForPerson).
(get-site ticket site-id)(get-site ticket site-id query-params & [opts])Gets information for site site-id.
You can use the relations parameter in query-params to include one or more relate entities in a single response and so reduce network traffic.
The entity types in Alfresco are organized in a tree structure.
The sites entity has two children, containers and members.
The following relations parameter returns all the container and member objects related to the site site-id: containers,members
More info here.
Gets information for site `site-id`. You can use the **relations** parameter in `query-params` to include one or more relate entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The **sites** entity has two children, **containers** and **members**. The following relations parameter returns all the container and member objects related to the site `site-id`: `containers,members`\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/getSite).
(get-site-container ticket site-id container-id)(get-site-container ticket site-id container-id query-params & [opts])Gets information on the container container-id in site site-id.
More info here.
Gets information on the container `container-id` in site `site-id`.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/getSiteContainer).
(get-site-membership ticket site-id person-id)(get-site-membership ticket site-id person-id query-params & [opts])Gets site membership information for person person-id on site site-id. You can use the **-me-** string in place ofperson-id` to specify the currently authenticated user.
More info here.
Gets site membership information for person `person-id` on site `site-id. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/getSiteMembership).
(get-site-membership-request ticket)(get-site-membership-request ticket query-params & [opts])Get the list of site membership requests the user can action.
You can use the where parameter in query-params to filter the returned site membership requests by site-id. For example:
(siteId=mySite)
The where parameter can also be used to filter by person-id. For example:
where=(personId=person)
This may be combined with the site-id filter, as shown below:
where=(siteId=mySite AND personId=person)
More info here.
Get the list of site membership requests the user can action. You can use the **where** parameter in `query-params` to filter the returned site membership requests by `site-id`. For example: ```clojure (siteId=mySite) ``` The **where** parameter can also be used to filter by `person-id`. For example: ```clojure where=(personId=person) ``` This may be combined with the `site-id` filter, as shown below: ```clojure where=(siteId=mySite AND personId=person) ``` More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/getSiteMembershipRequests).
(list-group-site-membership ticket site-id)(list-group-site-membership ticket site-id query-params & [opts])Gets a list of group membership for site site-id.
More info here.
Gets a list of group membership for site `site-id`.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/listSiteGroups).
(list-person-site-membership-requests ticket person-id)(list-person-site-membership-requests ticket person-id query-params & [opts])Gets a list of the current site membership requests for person person-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Gets a list of the current site membership requests for person `person-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/listSiteMembershipRequestsForPerson).
(list-person-site-memberships ticket person-id)(list-person-site-memberships ticket person-id query-params & [opts])Gets a list of site membership information for person person-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
You can use the where parameter in query-params to filter the returned sites by visibility or site preset.
Example to filter by visibility, use any one of:
(visibility='PRIVATE')
(visibility='PUBLIC')
(visibility='MODERATED')
Example to filter by site preset:
(preset='site-dashboard')
The default sort order for the returned list is for sites to be sorted by ascending title.
You can override the default by using the order-by parameter in query-params. You can specify one or more of the following fields in the order-by parameter:
More info here.
Gets a list of site membership information for person `person-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user. You can use the **where** parameter in `query-params` to filter the returned sites by **visibility** or site **preset**.\ Example to filter by **visibility**, use any one of: ```clojure (visibility='PRIVATE') (visibility='PUBLIC') (visibility='MODERATED') ``` Example to filter by site **preset**: ```clojure (preset='site-dashboard') ``` The default sort order for the returned list is for sites to be sorted by ascending title.\ You can override the default by using the **order-by** parameter in `query-params`. You can specify one or more of the following fields in the **order-by** parameter: - id - title - role More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/listSiteMembershipsForPerson).
(list-site-containers ticket site-id)(list-site-containers ticket site-id query-params & [opts])Gets a list of containers for site site-id.
More info here.
Gets a list of containers for site `site-id`.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/listSiteContainers).
(list-site-memberships ticket site-id)(list-site-memberships ticket site-id query-params & [opts])Gets a list of site memberships for site site-id.
More info here.
Gets a list of site memberships for site `site-id`.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/listSiteMemberships).
(list-sites ticket)(list-sites ticket query-params & [opts])Gets a list of sites in this repository.
You can use the where parameter in query-params to filter the returned sites by visibility or site preset.
More info here.
Gets a list of sites in this repository. You can use the **where** parameter in `query-params` to filter the returned sites by visibility or site preset.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/listSites).
(reject-site-membership-request ticket site-id invitee-id body & [opts])Reject a site membership request.
More info here.
Reject a site membership request.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/rejectSiteMembershipRequest).
(update-group-site-membership ticket site-id group-id body)(update-group-site-membership ticket
person-id
site-id
body
query-params
&
[opts])Update the membership of person group-id in site site-id.
You can set the role to one of four types:
More info here.
Update the membership of person `group-id` in site `site-id`. You can set the **role** to one of four types: - SiteConsumer - SiteCollaborator - SiteContributor - SiteManager More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/updateSiteGroupMembership).
(update-person-site-membership-request ticket person-id site-id body)(update-person-site-membership-request ticket
person-id
site-id
body
query-params
&
[opts])Updates the message for the site membership request to site site-id for person person-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.
Updates the message for the site membership request to site `site-id` for person `person-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/updateSiteMembershipRequestForPerson).
(update-site ticket site-id body)(update-site ticket site-id body query-params & [opts])Update the details for the given site site-id. Site Manager or otherwise a (site) admin can update title, description or visibility.
Note: the id of a site cannot be updated once the site has been created.
More info here.
Update the details for the given site `site-id`. Site Manager or otherwise a (site) admin can update title, description or visibility.\ **Note:** the id of a site cannot be updated once the site has been created.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/updateSite).
(update-site-membership ticket site-id person-id body)(update-site-membership ticket site-id person-id body query-params & [opts])Update the membership of person person-id in site site-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
You can set the role to one of four types:
More info here.
Update the membership of person `person-id` in site `site-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user.\ You can set the **role** to one of four types: - SiteConsumer - SiteCollaborator - SiteContributor - SiteManager More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/sites/updateSiteMembership).
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |