groupfolder
/members/{member}/groups/{group}/groupfolders/{groupfolderid} [PATCH]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9400 | 5.9900 | xml, json |
Description
Edit the group folder specified.
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.
If no public parameter is specified, there is no change to public sharing.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
editgroups | The groups the folder are to be shared to and editable – comma-separated list of names | no | strings | |
groups | The groups the folder are to be shared to – comma-separated list of names | no | strings | |
public | Whether URIs should be accessible to public | no | boolean |
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> [<thread> ... </thread>] </groupfolder-modification>
Error Handling
0x1406 | If the group folder id not found |
---|---|
0x140D | Invalid group |
0x140E | Group folder not owned by group |
0x1410 | The groups parameter can not contain the owner group |
0x1411 | A group can not be in both the groups and editgroups parameters |