Skip to main content

 Services

Web services from /about to /webhooks

groupfolders

/members/{member}/groups/{group}/groupfolders [POST]

Description

Create a new group folder with the path provided.

The path parameter can end with the suffix “/*” but if it does not, then the suffix is added. The path must belong to the {group} in the service URL.

Parameters

NameDescriptionRequiredTypeDefault
editgroupsThe groups the folder is to be shared to and editable – comma-separated list of names (one of public, groups, editgroups required)conditionalstrings
groupsThe groups the folder is to be shared to – comma-separated list of names (one of public, groups, editgroups required)conditionalstrings
pathThe full path of the group folder beginning with / (/* suffix is added automatically) e.g. /ps/acme/specs/sharedyespath
publicWhether URIs should be accessible to public (one of public, groups, editgroups required)conditionalboolean

Permission

Only Project managers or Administrators can invoke this service.

Response

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

<groupfolder-creation>
  <groupfolder id="[groupuri id]"
               scheme="[scheme]"
               host="[host]"
               port="[port]"
               path="[path]"
               external="[true|false]"
               public="[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>
  [<thread> ... </thread>]
</groupfolder-creation>

Error Handling

0x1403 If the group folder URL already exists in group
0x140A A public or group parameter is required
0x140B Invalid path
0x140C Group folder path not in group
0x140D Invalid group
0x1410 The groups parameter can not contain the owner group
0x1411 A group can not be in both the groups and editgroups parameters
0x6401 There is no default group folder for the group
Created on , last edited on