groupfolder

Description

Edit the specified group folder.

To remove individual groups from the sharing without having to list every group, you can also use the DELETE service

Parameters

groups/editgroups

These parameters let you specify the list of groups that the folder is shared to as a comma-separated list of group names. The names must not include admin, public or the owner group specified in the service URL as {group}.

Groups specified by groups parameter only have read access, while groups specified in the editgroups also give edit permissions to members who edit permissions on these groups (contributor and above).

You must have project manager access to each of the specified groups and groups can only be specified once for each parameters and cannot be specified for both.

If groups and editgroups parameters are not specified, there are no changes to shared groups. To remove all shared groups, an empty groups or editgroups parameter must be specified.

public

Use this parameter to make this folder accessible publicly. When a group folder is made “public”, it only affects the permissions so that the folder and any folder or document within it can be read without any permission check, but folders are listed in groups they are explicitly shared to.

If no public parameter is specified, there is no change to public sharing.

Other sharing permissions specified by the groups and editgroups still apply.

Permission

Only project managers or administrators can invoke this service.

Response

If successful, the modified group folder is returned as a  <groupfolder> element wrapped in a <groupfolder-modification> element.

<groupfolder-modification>
  <groupfolder id="[groupuri id]"
               scheme="[scheme]"
               host="[host]"
               port="[port]"
               path="[path]"
               external="[true|false]"
               sharing="[private|shared]">
    <sharing status="[private|shared]" 
             [hidden="2"] 
             [public="true"]>
      <share editable="true" 
             shareedits="true" 
             sharexrefs="true" 
             addcomments="true" 
             owner="true">
        <group name="my-group1" .../>
      </share>
      <share editable="true" 
             shareedits="false" 
             sharexrefs="true" 
              addcomments="false">
        <group name="my-group2" .../>
      </share>
      <share editable="false" 
             shareedits="true" 
             sharexrefs="false" 
             addcomments="true">
        <group name="my-group3" .../>
      </share>
    </sharing>
  </groupfolder>
</groupfolder-modification>

Or in JSON

{
  "groupfolder": { 
    "id": number,
    "scheme": string,
    "host": string,
    "port": number,
    "path": string,
    "external": boolean,
    "public": boolean,
    "sharing": string,
    "sharing": {
      "status": string,
      "share":[
        {
          "owner": boolean,
          "editable": boolean,
          "addcomments": boolean,
          "shareedits": boolean,
          "sharexrefs": boolean,
          "group": group
        }
      ]
    }
  }
}

Error Handling