サイト取得
概要¶
APIを使用してサイト情報を取得することができます。
制限事項¶
- wikiには対応していません。
-
1.5.10.0
取得するサイトの「サイトの管理権限」が無いユーザ(特権ユーザを除く)が実行した場合、
SiteSettings(項目のラベルや選択肢などのサイトの設定)は取得できません。テナント管理者であっても、サイトの管理権限が無い場合は同じです。SiteIdやTitleなどのサイトの情報は取得できます。SiteSettingsを参照する処理では、値があることを確かめてから使用してください。
事前準備¶
APIの操作を行う前にAPIキーの作成を実施してください。また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。
リクエスト¶
下記のリクエスト形式で、jsonデータを送信します。
| 設定項目 | 値 |
|---|---|
| HTTPメソッド | POST |
| Content-Type | application/json |
| 文字コード | UTF-8 |
| URL | http://{サーバ名}/api/items/{サイトID}/getsite(※1) |
| Body | 以下のjsonデータを参考のこと |
(※1){サーバ名}、{サイトID}の部分は、適宜、環境に合わせて編集してください。
pleasanter.netの場合は以下の形式になります。
https://pleasanter.net/fs/api/items/{サイトID}/getsite
{サイトID}には、取得対象のサイトIDを指定してください。
JSON¶
レスポンス¶
下記の形式のJSONデータが返却されます。
JSON¶
{
"StatusCode": 200,
"Response": {
"Data": {
"TenantId": 1,
"SiteId": 12345,
"UpdatedTime": "2023-08-17T12:00:00",
"Ver": 1,
"Title": "記録テーブル",
"Body": "",
"SiteName": "",
"SiteGroupName": "",
"GridGuide": "",
"EditorGuide": "",
"CalendarGuide": "",
"CrosstabGuide": "",
"GanttGuide": "",
"BurnDownGuide": "",
"TimeSeriesGuide": "",
"KambanGuide": "",
"ImageLibGuide": "",
"ReferenceType": "Results",
"ParentId": 12344,
"InheritPermission": 3301,
"Permissions": [
],
"SiteSettings": {
"Version": 1.017,
"ReferenceType": "Results",
"EditorColumnHash": {
"General": [
"ResultId",
"Ver",
"Title",
"Body",
"Status",
"Manager",
"Owner",
"Comments",
"ClassA",
"ClassB",
"ClassC"
]
},
"NoDisplayIfReadOnly": false
},
"Publish": false,
"DisableCrossSearch": false,
"LockedTime": "1899-12-30T00:00:00",
"LockedUser": 0,
"ApiCountDate": "1899-12-30T00:00:00",
"ApiCount": 0,
"Comments": "[]",
"Creator": 1,
"Updator": 1,
"CreatedTime": "2023-08-17T09:00:00",
"ApiVersion": 1.1,
"ClassHash": {
},
"NumHash": {
},
"DateHash": {
},
"DescriptionHash": {
},
"CheckHash": {
},
"AttachmentsHash": {
}
}
}
}
Note
バージョン1.5.10.0以降では、SiteSettingsの「AI連携」の設定に含まれるAPIキーは、マスクした文字列********です。サイト作成APIやサイトパッケージのインポートでこの値を使ってサイトを作成すると、作成したサイトのAPIキーは空になります。作成後に「テーブルの管理:AI連携」でAPIキーを設定し直してください。
サンプルコード¶
Note
コード内の【 ... 】は適宜修正してください。
1. 複数のテーブルの、項目の物理名と表示名の対応表をCSVに出力する
サイトID一覧(CSV)のテーブルごとに、サイト取得APIでエディタの項目を取得し、物理名(ClassAなど)と表示名(「顧客名」など)の対応表を、1行1項目のCSVに出力します。表示名が設定されていない項目は、既定の表示名(「分類B」など)で補います。
実務での使いどころ¶
スクリプト・API・拡張SQLを書くときや、テーブルの設計書をまとめるときに、項目の物理名と表示名の対応を一覧で確かめたいときに使えます。対応は、テーブルごとに「テーブルの管理」の「エディタ」を開いて1項目ずつ確かめる必要があり、複数のテーブルをまとめて一覧にする機能はありません。
事前準備¶
1:対応表を作りたいテーブルのIDを、1行目を見出しSiteIdにしたCSV(sites.csv、UTF-8)に書きます。
2:サンプルコードのBASE_URL・API_KEYを書き換えてください。APIキーのユーザには、各テーブルの「サイトの管理権限」が必要です。バージョン1.5.10.0以降は、サイトの管理権限が無いとサイトの設定(SiteSettings)を取得できないためです。
Python¶
出力の例(column_labels.csv)¶
サイトID,テーブル名,タブ,物理名,表示名,表示名を変えたか,備考
887,顧客台帳,General,ResultId,ID,,
887,顧客台帳,General,Title,タイトル,,
887,顧客台帳,General,ClassA,顧客名,はい,
887,顧客台帳,General,ClassB,分類B,,
869,案件フォルダ,,,,,テーブルではないため対象外
注記¶
- 対象は、エディタに出している項目です。エディタの項目を一度も変えていないテーブルは、備考に「既定のまま」と出します。
- 見出しやリンクなど、項目ではない要素は出しません。
- サイトの管理権限が無いテーブルは、備考に「設定を取得できない(サイトの管理権限が無い)」と出します。
- 拡張項目は、A〜Zの項目(分類A〜分類Zなど)の既定の表示名で補います。
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.3.4.0 以降 | 機能追加 |
| 1.5.10.0 以降 | サイトの管理権限が無いユーザが実行した場合、SiteSettingsを取得できないよう変更AI連携のAPIキー( ApiKey)を、マスクした文字列で返却するよう変更 |
