Move Site

Overview¶

Use the API to change the parent site (folder hierarchy) of a site.

Until now, sites could be moved only by drag and drop on the site menu. With this API, you can change the site hierarchy from an external program. The child sites of the site to be moved move together with it. You do not need to run the API for each child site.

Cautions¶

1. Moving a site does not change its permission inheritance source (InheritPermission). To change the permission inheritance to match the destination, change it separately with Update Site or on the site settings screen.

Limitations¶

1. You can specify only a folder (a site whose reference type is "Sites") as the destination. Specifying a table (Issues, Results, Wiki, and so on) as the destination results in an error.
2. You cannot specify the site to be moved itself or any of its descendant sites as the destination. Doing so results in an error.
3. You can specify only a site in the same tenant as the user who runs the API as the destination.
4. ParentId of Update Site cannot be used to move a site. Use this API to move a site.

Prerequisites¶

1. Create an API Key.
2. The Enabled parameter of Api.json must be set to true.

3. The user must have the "Manage site" permission for the site to be moved, the parent site of the site to be moved (the source), and the destination site. If the site to be moved is directly under the top, the permission for the source parent site is not required.

   

4. If DisableTopSiteCreation of User.json is true, to specify the top (0 for ParentId) as the destination, the user must have "Allow creation at the top of the site" enabled in "User administration".

5. If DisableMovingFromTopSite of User.json is true, to move a site directly under the top, the user must have "Allow moving from the top of the site" enabled in "User administration".

Request¶

Send JSON data in the following request format:

Items to Specify in Body¶

{
    "ApiVersion": 1.1,
    "ApiKey": "345yuAjA6789dA09d8uj6...",
    "ParentId": 12300
}

Specifying 0 for ParentId moves the site to the top.

{
    "ApiVersion": 1.1,
    "ApiKey": "345yuAjA6789dA09d8uj6...",
    "ParentId": 0
}

API Parameters¶

Execution Example Samples¶

To move a site under the folder with site ID "12300", specify the following.

PowerShell Sample¶

$body = @{
    ApiVersion = 1.1
    ApiKey     = "345yuAjA6789dA09d8uj6..."
    ParentId   = 12300
} | ConvertTo-Json
Invoke-RestMethod -Uri "https://{{server name}}/api/items/12345/MoveSite" -Method Post -ContentType "application/json; charset=utf-8" -Body $body

Python Sample¶

import requests

res = requests.post("https://{{server name}}/api/items/12345/MoveSite", json={
    "ApiVersion": 1.1,
    "ApiKey": "345yuAjA6789dA09d8uj6...",
    "ParentId": 12300,
})
print(res.status_code, res.json())

curl Sample¶

curl -X POST "https://{{server name}}/api/items/12345/MoveSite" \
  -H "Content-Type: application/json" \
  -d '{"ApiVersion":1.1,"ApiKey":"345yuAjA6789dA09d8uj6...","ParentId":12300}'

Response¶

If successful, JSON data in the following format is returned.

{
    "Id": 12345,
    "StatusCode": 200,
    "Message": "\" Sales Department \" has been moved."
}

In case of an error, the following is returned.

Confirmation Items in Case of Error¶

・Precautions when using the API and things to check if an error occurs
・FAQ: What to check if modified configuration files or API requests (JSON format) are not recognized correctly

Supported Versions¶

Related Information¶

• Create an API Key
• Update Site
• $p.apiMoveSite
• Api.json
• User.json
• User Management Function: Creation and Update