create groupfolder
/groups/{group}/groupfolders/create [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
Description
Create a new group folder, also known as “Group URI”, with the URL specified in the request.
This URL has been deprecated in PageSeeder 5.9 and has been scheduled to be removed.
Use Service: /members/{member}/groups/{group}/groupfolders [POST] instead.
The url parameter can end with the suffix "/*
" but if it does not then the suffix is added automatically.
Default group folders (i.e. /ps/[project]/[group]/*
) are always editable by group.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
url | The url of the group folder (/* suffix is added automatically) | yes | string | |
editable | Whether URIs should be editable by this group | no | boolean | false |
Permission
This service requires administrator.
Response
If successful, the group folder that was created is returned as <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]" editable="[true|false]" public="[true|false]" [sharing="[private|shared]"] /> </groupfolder> </groupfolder-creation>
Error Handling
Code | Cause / Description |
---|---|
0x1401 | If the url is invalid |
0x1402 | If the host is unknown |
0x1403 | If the group folder URL already exists in group |