delphiDll / Atlassian Confluence Cloud / Move a page to a new location relative to a target page
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
pageId: PWideChar;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
resp := CkHttp_QuickRequest(http,'PUT','https://your-domain.atlassian.net/wiki/rest/api/content/:id/move/:position/:targetId');
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "pageId": "Duis "
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
pageId := CkJsonObject__stringOf(jResp,'pageId');
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/content/:id/move/:position/:targetId
Postman Collection Item JSON
{
"name": "Move a page to a new location relative to a target page",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PUT",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/move/:position/:targetId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"move",
":position",
":targetId"
],
"variable": [
{
"key": "id",
"value": "<string>",
"type": "string",
"description": "(Required) The ID of the page to be moved"
},
{
"key": "position",
"value": "<string>",
"type": "string",
"description": "(Required) The position to move the page to relative to the target page:\n* `before` - move the page under the same parent as the target, before the target in the list of children\n* `after` - move the page under the same parent as the target, after the target in the list of children\n* `append` - move the page to be a child of the target"
},
{
"key": "targetId",
"value": "<string>",
"type": "string",
"description": "(Required) The ID of the target page for this operation"
}
]
},
"description": "Move a page to a new location relative to a target page:\n\n* `before` - move the page under the same parent as the target, before the target in the list of children\n* `after` - move the page under the same parent as the target, after the target in the list of children\n* `append` - move the page to be a child of the target\n\nCaution: This API can move pages to the top level of a space. Top-level pages are difficult to find in the UI\nbecause they do not show up in the page tree display. To avoid this, never use `before` or `after` positions\nwhen the `targetId` is a top-level page."
},
"response": [
{
"name": "Page was successfully moved",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/move/:position/:targetId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"move",
":position",
":targetId"
],
"variable": [
{
"key": "id"
},
{
"key": "position"
},
{
"key": "targetId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"pageId\": \"Duis \"\n}"
},
{
"name": "Returned if;\n\n- A page already exists in the target space with the same name.\n User is advised to rename page before moving.\n- The move would create a parent-child loop (page becomes a descendant and ancestor of itself)\n- The page has permission restrict",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/move/:position/:targetId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"move",
":position",
":targetId"
],
"variable": [
{
"key": "id"
},
{
"key": "position"
},
{
"key": "targetId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if;\n\n- User does not have permission to remove page from current space\n- User does not have permission to create a page in target space",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/move/:position/:targetId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"move",
":position",
":targetId"
],
"variable": [
{
"key": "id"
},
{
"key": "position"
},
{
"key": "targetId"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if;\n\n- The id or targetId refer to non-existent pages",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/content/:id/move/:position/:targetId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"move",
":position",
":targetId"
],
"variable": [
{
"key": "id"
},
{
"key": "position"
},
{
"key": "targetId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
