サイト移動

概要¶

APIを使用してサイトの親サイト（フォルダ階層）を変更します。

これまでサイトの移動は、サイトメニュー上でのドラッグ&ドロップ操作でのみ行えました。本APIにより、外部プログラムからサイトの階層構造を変更できます。移動対象のサイトが持つ子サイトは、親サイトに追随して移動します。子サイトに対して個別にAPIを実行する必要はありません。

注意事項¶

1. 移動してもサイトの「権限の継承元」（InheritPermission）は変更されません。移動先に合わせて権限の継承を変更する場合は、別途サイト更新またはサイトの設定画面から変更してください。

制限事項¶

1. 移動先にはフォルダ（参照タイプが「Sites」のサイト）のみ指定できます。テーブル（期限付き、記録、Wiki等）を移動先に指定した場合はエラーとなります。
2. 移動対象のサイト自身、および移動対象のサイトの子孫にあたるサイトは移動先に指定できません。指定した場合はエラーとなります。
3. 移動先には、APIを実行するユーザと同じテナントのサイトのみ指定できます。
4. サイト更新の ParentId はサイトの移動には使用できません。サイトを移動する場合は本APIを使用してください。

前提条件¶

1. APIキーの作成を実施すること。
2. Api.jsonの Enabled パラメータが true に設定されていること。

3. 移動対象のサイト、移動対象のサイトの親サイト（移動元）、および移動先のサイトの管理権限をもつユーザであること。移動対象のサイトがトップ直下にある場合、移動元の親サイトの管理権限は不要です。

   

4. User.jsonの DisableTopSiteCreation が true の場合、移動先にトップ（ParentId に 0）を指定するには「ユーザの管理」で「サイトトップへの作成を許可」が有効なユーザであること。

5. User.jsonの DisableMovingFromTopSite が true の場合、トップ直下のサイトを移動するには「ユーザの管理」で「サイトトップからの移動を許可」が有効なユーザであること。

リクエスト¶

下記のリクエスト形式で、JSONデータを送信します。

Bodyに指定する項目¶

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

ParentId に 0 を指定すると、サイトはトップに移動されます。

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

APIパラメータ¶

実行例のサンプル¶

サイトID「12300」のフォルダの配下へ移動するには以下のように指定します。

PowerShellのサンプル¶

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

Pythonのサンプル¶

import requests

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

curlのサンプル¶

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

レスポンス¶

成功した場合、下記の形式のJSONデータが返却されます。

{
    "Id": 12345,
    "StatusCode": 200,
    "Message": "\" 営業部 \" を移動しました。"
}

エラーの場合は下記が返却されます。

エラー時の確認事項¶

・API使用時の注意点やエラーが発生する場合の確認事項
・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項

対応バージョン¶

関連情報¶

• 開発者ガイド：API：APIキーの作成
• 開発者ガイド：API：サイト更新
• 開発者ガイド：スクリプト：$p.apiMoveSite
• パラメータ設定：Api.json
• パラメータ設定：User.json
• 管理者ガイド：ユーザ管理：作成・更新