Chilkat Online Tools

phpAx / Atlassian Confluence Cloud / Copy page hierarchy

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "destinationPageId": "Duis in",
//   "copyAttachments": false,
//   "copyPermissions": false,
//   "copyProperties": false,
//   "copyLabels": false,
//   "copyCustomContents": false,
//   "titleOptions": {
//     "prefix": "<string>",
//     "replace": "<string>",
//     "search": "<string>"
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('destinationPageId','Duis in');
$json->UpdateBool('copyAttachments',0);
$json->UpdateBool('copyPermissions',0);
$json->UpdateBool('copyProperties',0);
$json->UpdateBool('copyLabels',0);
$json->UpdateBool('copyCustomContents',0);
$json->UpdateString('titleOptions.prefix','<string>');
$json->UpdateString('titleOptions.replace','<string>');
$json->UpdateString('titleOptions.search','<string>');

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('Content-Type','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://your-domain.atlassian.net/wiki/rest/api/content/:id/pagehierarchy/copy','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "destinationPageId": "Duis in",
    "copyAttachments": false,
    "copyPermissions": false,
    "copyProperties": false,
    "copyLabels": false,
    "copyCustomContents": false,
    "titleOptions": {
        "prefix": "<string>",
        "replace": "<string>",
        "search": "<string>"
    }
}'
https://your-domain.atlassian.net/wiki/rest/api/content/:id/pagehierarchy/copy

Postman Collection Item JSON

{
  "name": "Copy page hierarchy",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"destinationPageId\": \"Duis in\",\n    \"copyAttachments\": false,\n    \"copyPermissions\": false,\n    \"copyProperties\": false,\n    \"copyLabels\": false,\n    \"copyCustomContents\": false,\n    \"titleOptions\": {\n        \"prefix\": \"<string>\",\n        \"replace\": \"<string>\",\n        \"search\": \"<string>\"\n    }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/content/:id/pagehierarchy/copy",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "content",
        ":id",
        "pagehierarchy",
        "copy"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<string>",
          "type": "string",
          "description": "(Required) "
        }
      ]
    },
    "description": "Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments.\n The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body.\n The titleOptions object defines the rules of renaming page titles during the copy;\n for example, search and replace can be used in conjunction to rewrite the copied page titles.\n\n Response example:\n <pre><code>\n {\n      \"id\" : \"1180606\",\n      \"links\" : {\n           \"status\" : \"/rest/api/longtask/1180606\"\n      }\n }\n </code></pre>\n Use the /longtask/<taskId> REST API to get the copy task status."
  },
  "response": [
    {
      "name": "Returns a full JSON representation of a long running task",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationPageId\": \"id in esse\",\n    \"copyAttachments\": false,\n    \"copyPermissions\": false,\n    \"copyProperties\": false,\n    \"copyLabels\": false,\n    \"copyCustomContents\": false,\n    \"titleOptions\": {\n        \"prefix\": \"<string>\",\n        \"replace\": \"<string>\",\n        \"search\": \"<string>\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/content/:id/pagehierarchy/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "pagehierarchy",
            "copy"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Accepted",
      "code": 202,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Returned if original page or destination page doesn't exist.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationPageId\": \"id in esse\",\n    \"copyAttachments\": false,\n    \"copyPermissions\": false,\n    \"copyProperties\": false,\n    \"copyLabels\": false,\n    \"copyCustomContents\": false,\n    \"titleOptions\": {\n        \"prefix\": \"<string>\",\n        \"replace\": \"<string>\",\n        \"search\": \"<string>\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/content/:id/pagehierarchy/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "pagehierarchy",
            "copy"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Returned if the user does not have permission to create content at destination",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationPageId\": \"id in esse\",\n    \"copyAttachments\": false,\n    \"copyPermissions\": false,\n    \"copyProperties\": false,\n    \"copyLabels\": false,\n    \"copyCustomContents\": false,\n    \"titleOptions\": {\n        \"prefix\": \"<string>\",\n        \"replace\": \"<string>\",\n        \"search\": \"<string>\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/content/:id/pagehierarchy/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "pagehierarchy",
            "copy"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}