サイト更新
概要¶
APIを使用してサイト設定を更新することができます。
事前準備¶
APIの操作を行う前にAPIキーの作成を実施してください。また、この機能は「サイトの管理」権限をもつユーザでなければ使用できません。
リクエスト¶
下記のリクエスト形式で、jsonデータを送信します。
| 設定項目 | 値 |
|---|---|
| HTTPメソッド | POST |
| Content-Type | application/json |
| 文字コード | UTF-8 |
| URL | http://{サーバ名}/api/items/{サイトID}/updatesite(※1) |
| Body | 以下のjsonデータを参考のこと |
(※1){サーバ名}、{サイトID}の部分は、適宜、環境に合わせて編集してください。
pleasanter.netの場合は以下の形式になります。
https://pleasanter.net/fs/api/items/{サイトID}/updatesite
{サイトID}には、更新対象のサイトIDを指定してください。
JSON¶
{
"ApiVersion": "1.1",
"ApiKey": "345yuAjA6789dA09d8uj6...",
"TenantId": 1,
"Title": "サイト名",
"ReferenceType": "Issues",
"InheritPermission": 99999,
"SiteSettings": {
"Version": 1.017,
"ReferenceType": "Issues",
"GridColumns": [
"IssueId",
"TitleBody",
"Comments",
"StartTime",
"CompletionTime",
"WorkValue",
"ProgressRate",
"RemainingWorkValue",
"Status",
"Manager",
"Owner",
"Updator",
"UpdatedTime"
],
"EditorColumnHash": {
"General": [
"IssueId",
"Ver",
"Title",
"Body",
"StartTime",
"CompletionTime",
"WorkValue",
"ProgressRate",
"RemainingWorkValue",
"Status",
"Manager",
"Owner",
"Comments"
]
}
},
"VerUp": true
}
※TenantID以降のパラメータについては、サイトパッケージをエクスポートした際の、"Site”パラメータと同等の値を設定してください。
Note
バージョン1.5.10.0以降は、AiProvidersのApiKeyにマスクした文字列********を指定すると、設定値は更新されません。
サンプルコード¶
Note
コード内の【 ... 】は適宜修正してください。
1. テンプレートのテーブルで直した画面の設定を、同じ種類の複数のテーブルへ配る
テンプレートのテーブルと、設定を配るテーブルをサイト取得APIで取得し、テンプレートと値が違う画面の設定(一覧の列・エディタの項目など)をテーブルごとに一覧にします。DRY_RUN = Falseにして実行すると、サイト更新APIで、各テーブルの画面の設定をテンプレートと同じにします。テーブルの名前とアクセス権の継承は、各テーブルの値のまま送ります。
実務での使いどころ¶
支店・拠点ごと、案件ごとに同じ形のテーブル(「問い合わせ管理」「点検記録」など)を並べて運用しているときに、本部がテンプレートで直した項目の並びや選択肢を、全てのテーブルへ同じ日に反映できます。サイトパッケージのインポートやサイトのコピーは新しいサイトを作る機能のため、運用中のテーブルの設定のみを差し替えることはできません。
事前準備¶
1:テンプレートのテーブルで、配りたい画面の設定(一覧・エディタ・項目の表示名・ビューなど)を直しておきます。
2:サンプルコードのBASE_URL・API_KEY・TEMPLATE_SITE_ID(テンプレートのサイトID)・TARGET_SITE_IDS(設定を配るテーブルのサイトID)を書き換えてください。APIキーは、テナント管理者のユーザで発行したものを使います。APIキーのユーザには、テンプレートと配る先のテーブルの「サイトの管理権限」が必要です。バージョン1.5.10.0以降は、サイトの管理権限が無いとサイトの設定(SiteSettings)を取得できないためです。
3:まずDRY_RUN = Trueのまま実行して一覧を確かめ、Falseにして実行します。
Python¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
表示の例(DRY_RUN = True)¶
テンプレート:100「課題管理(テンプレート)」(Issues)
[更新予定] 101「課題管理(東京支店)」:Columns, EditorColumnHash, GridColumns
[変更なし] 102「課題管理(大阪支店)」
[飛ばした] 103「点検記録(東京支店)」:種類が違う(Results)
更新 0 件、更新予定 1 件、変更なし 1 件、飛ばした 1 件、失敗 0 件
注記¶
- 送るのは、テーブルの名前・種類・アクセス権の継承(各テーブルの値)と、画面の設定(テンプレートの値)です。テーブルの説明やアクセス権は送りません。
- 種類(期限付きテーブル・記録テーブル)がテンプレートと違うテーブル、テンプレート自身、重複したサイトID、取得できないサイトIDは、送らずに理由を表示します。
- テンプレートの設定を取得できないときは、何も送らずに止まります。設定を取得できないテーブルは、送らずに飛ばします。
- リンク・ルックアップの参照先や、スクリプトの中のサイトIDなど、テーブルごとに違う値にしたい設定も、テンプレートの値がそのまま配られます。テンプレートの設定の中にテンプレート自身のサイトIDと同じ数字があるときは、最初に「[注意]」を表示します。
VerUpは1.5.6.0以降で使えます。それより前のバージョンでは、VER_UP = Falseにしてください。
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.3.4.0 以降 | 機能追加 |
| 1.5.6.0 以降 | VerUpを追加 |
| 1.5.10.0 以降 | AI連携のAPIキー(ApiKey)がマスクした文字列の場合は、保存済みのAPIキーを使うよう変更 |
