Create URI version
/members/{member}/groups/{group}/uris/{uri}/versions [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9500 | 6.3004 | xml, json |
Description
Create a new version.
Adds a version to a uri, or if the uri is a folder, the uris under it.
If the URI is a folder, this service starts an asynchronous process.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| name | The version number or name | yes | string | |
| description | The version content | no | string | |
| labels | General label values for comment (e.g. Important, Typo) | no | labels | |
| notify | Send notification flag, e.g. silent, normal, announce | no | enum | silent |
| notify-async | Whether emails should be sent asynchronously (for slow email servers) | no | boolean | false |
| publicationid | The ID of the publication associated with the version | no | publicationid |
Notify parameter
This parameter must be one of:
normal– notify based on each members’ notification settings;announce– ignores members’ individual notifications settings;silent– no notification.
Permission
This service requires approver or above.
Response
If uri is a document, the output has the following format:
<version-creation [warning="[warning]"]
[notify-param-ignored=true"]>
<version id="[id]"
name="[version name]"
created="[date/time]">
<author id="12" ... >
<fullname>John Jones</fullname>
</author>
<description>[content of version]</description>
<labels>[labels]</labels>
</version>
</version-creation>
If uri is a folder, the output is:
<version-creation> <thread ...> ... </thread> </version-creation>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1212 | Invalid URL |
| 0x1213 | URI not found |
| 0x122E | The labels parameter is invalid |
| 0x1245 | A version name is required |
| 0x1246 | Version name cannot be 'original' or 'current' or more than 250 characters |
| 0x1247 | Failed to create version |
| 0x1331 | The notify parameter is invalid |