Confluence REST API - Copy page hierachy

CEDRIC DEVAUX

Hi,

 

I use the rest api call to duplicate page hierarchy (parent & child pages) from a origin space to destination space.

 

curl --request POST \

--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/pagehierarchy/copy' \ --user 'email@example.com:<api_token>' \

--header 'Accept: application/json' \ --header 'Content-Type: application/json' \

--data '{

"copyAttachments": true,

"copyPermissions": true,

"copyProperties": true,

"copyLabels": true,

"copyCustomContents": true,

"copyDescendants": true,

"destinationPageId": "<string>",

"titleOptions": {

                        "prefix": "<string>",

                        "replace": "<string>",

                        "search": "<string>"

                          }

}'

I use example from Confluence rest api catalog and in the part titleOptions it has 3 properties:

prefix --> I understand that I that to prefix title to allow to copy parent and child pages

 

Could you explain me what is the purpose of "Search" and "replace"  properties?

 

Thank you

 

Cedric

 

unknown

Hello @CEDRIC DEVAUX 

Those two properties are for searching and replacing words from the titles of the source pages when copying pages in the same space, since Confluence doesn't allow two pages in the same space to have the same title.

For example, if all the titles of the source pages contained the word "dogs" and you wanted all the titles of all the copied pages to use the word "cats" instead, you'd use:

  "titleOptions": {
    "search": "dogs",<br>    "replace": "cats"
  }

Combined with the prefix property, it gives you a bit more flexibility in ensuring pages copied into the same space have unique titles.