Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring Import

Copies the specified documents.

Use the /authoring/v1/copy/sync endpoint to copy the specified documents for the current tenant. Currently supported document classifications are asset and content. As for all Acoustic Content PUT and POST requests, the Content-Type header should be set to application/json. <br />User roles: admin, manager

post/authoring/v1/copy/sync

Query parameters

referencesToClearstring

Optional comma separated list of reference types to clear within copied documents. Supported values: asset, content, category, image-profile

referencesToClonestring

Optional comma separated list of reference types to copy (when referenceLevels > 0). Defaults to the reference types of the initial items to copy. Supported values: asset, content

referenceLevelsnumber

The number of reference levels to copy. Defaults to 0, meaning to copy only the specified items.

clearElementsOnLastLevelboolean

Specifies whether the elements on the last level of references should have their elements cleared. Has no effect when referencesLevels is not greater than zero.

Headers

x-ibm-dx-publish-priority'now' string

Specify now to bypass the publishing schedule.

Request body

string[] required

The items to copy. The items need to be either ready OR belong to same project. Additional parameters "name", "add" and "remove" can be passed with each item to modify the name and add or remove a property from the copied item. Format is "[classification]:[id]?name=[custom-name];remove={"kind":["sample"],"description":""};add={"kind":["email"]}" The above parameters mean that the (a) name of the copied item would be <custom-name>. (b) "email" will be added to the "kind" array in the copied object. (c) "sample" will be removed from "kind" array in the copied object. (d) "description" will be removed from the copied object.

Example request

[
  "content:2fd35e68-b4d2-4608-8dbe-82c42b321bd9",
  "content:2fd35e68-b4d2-4608-8dbe-82c42b321bd9:draft",
  "content:2fd35e68-b4d2-4608-8dbe-82c42b321bd9?name=custom-name",
  "content:2fd35e68-b4d2-4608-8dbe-82c42b321bd9?name=mycontent;remove={\"kind\": [\"sample\"]};add={\"kind\":[\"email\"]"
]

Response

Results of the copy operation.

classification'copy'

the document classification.

status'success' | 'failed'

the status of the copy operation.

paramsobject

The list of query parameters applied for the copy operation.

rootCopiedItemCountinteger

The number of root items copied in this request.

rootCopiedItemListobject

A mapping of all root source item ids to the copied item ids.

nonrootCopiedItemCountinteger

The number of non-root items copied in this request.

nonrootCopiedItemListobject

A mapping of all non-root source item ids to the copied item ids.

failedToCopyCountinteger

The number of source items for which the copy operation failed.

failedToCopyListobject

The list of failed source item ids to failure data. Failure data format is 'isRoot:::clearElements'

Example response

{
  "params": {
    "referenceLevels": "5",
    "referencesToClone": "content",
    "clearElementsOnLastLevel": "false"
  },
  "rootCopiedItemList": {
    "content:::item1-id": "content:::item1-id-copy",
    "content:::item2-id": "content:::item2-id-copy"
  },
  "nonrootCopiedItemList": {
    "content:::item1-id": "content:::item1-id-copy",
    "content:::item2-id": "content:::item2-id-copy"
  },
  "failedToCopyList": {
    "content:::item1-id-copy": "false:::false",
    "content:::item2-id-copy": "true:::false"
  }
}