create publication version
/members/{member}/groups/{group}/publications/{publicationid}/versions [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9802 | 6.0005 | xml, json |
Description
Versions all documents in a publication.
Starting at publication root URI, adds versions to all xref target URIs (except when xref type="none"
). If xref type="embed"
or type="transclude"
with a PSML target URI, it recursively processes the target URI’s xrefs as well (if target is a fragment, it only follows xrefs for that fragment).
Invoking this service starts an Asynchronous process.
Parameters
Name | Description | Required | Type | Default value |
---|---|---|---|---|
description | The version content | no | string | |
labels | General labels for comment (e.g. Important , Typo ) | no | labels | |
name | The version number or name | yes | string | |
notify | Send notification flag, e.g. silent , normal , announce | no | string | silent |
notify-async | Whether emails are sent asynchronously (for slow email servers) | no | boolean | false |
Permission
Requires approver in the group of the publication root document.
Response
<version-creation> <thread id="123" ...>[thread XML]</thread> </version-creation>
Error Handling
Code | Cause / Description |
---|---|
0x122E | The labels parameter is invalid |