duplicate psml
/members/{member}/groups/{group}/uris/{uri}/duplicate [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.5912 | 6.1000 | xml, json |
Description
Duplicate a PSML document.
The duplicated document is created in the same folder as the original.
Parameters
Name | Description | Required | Type | Default value |
---|---|---|---|---|
filename | Name of file to create (without extension) | yes | string | |
description | Description of new document | no | string | |
docid | Document ID | no | string | |
labels | Comma-separated list of document labels | no | string | |
notification-content | Content of notification | no | string | |
notification-groups | Comma-separated list of group names to notify (optional, default to current group name) | no | string | |
notification-labels | Comma-separated list of label values for the note (if exists, creates a note) | no | string | |
notification-subject | Subject of notification (default to document title or “Document Created”) | no | string | |
notify | Notification behavior | no | enum | silent |
notify-async | Whether emails should be sent asynchronously (for slow email servers) | no | boolean | false |
original-docid | Document ID for original document if not already set, so variations can be compared | no | string | |
title | Display title of new document | no | string | |
variation | Whether to create variation metadata (requires docid on original). Requires PageSeeder v6.1 or higher. | no | boolean | true |
notify
normal|announce|silent
Permission
This service requires contributor or higher.
Response
<document-creation [renamed="true" original-name="new:document.psml"]> <uri id="138614" scheme="https" host="localhost" port="443" path="/ps/jb/group1/documents/new_document.psml" decodedpath="/ps/jb/group1/documents/new_document.psml" external="false" mediatype="application/vnd.pageseeder.psml+xml" created="2013-12-19T15:14:54+11:00"> <displaytitle>Copied document</displaytitle> </uri> </document-creation>
Error Handling
Code | Cause / Description |
---|---|
0x1201 | Illegal character in filename |
0x120A | Invalid Document ID |
0x1209 | Existing Document ID |
0x1211 | Existing URI |