コンテンツにスキップ

items.GetSite

概要

itemsオブジェクトの「GetSiteメソッド」です。指定したサイトIDをもとにサイトの情報を取得します。

構文

items.GetSite(id)

パラメータ

パラメータ 型 必須 説明
id object ○ サイトIDを指定

戻り値

該当するサイトの「apiModel 」の配列を返却します。

使用例

以下の例では、サイトID 123 のサイト情報を取得します。

const sites = Array.from(items.GetSite(123));
if (sites.length) {
    context.Log(sites[0].SiteId);
    context.Log(sites[0].Title);
    context.Log(sites[0].ReferenceType);
}

サンプルコード

1. リンク集にサイトIDを入れると、サイトの名前と種類を入れる

「リンク集」のレコードにサイトIDを入れて保存すると、items.GetSiteでそのサイトを取得し、サイトの名前をタイトルに、種類(フォルダ・期限付きテーブル・記録テーブルなど)を分類Aに入れます。

実務での使いどころ

部署のポータルや、よく使うテーブルの案内(リンク集)を作るときに使えます。サイトの名前を手で写さずに済み、サイトの名前を変えたあとも、レコードを保存し直すと新しい名前になります。リンクやルックアップでは、サイトの名前や種類を項目に入れることはできません。

事前準備

1:「リンク集」テーブル(記録テーブル)で、以下の項目を有効化してください。

項目コード 内容
タイトル(Title) サイトの名前(自動で入る)
数値A(NumA) サイトID
分類A(ClassA) サイトの種類(自動で入る)

2:「リンク集」テーブルにスクリプトを登録します。

2-1:「テーブルの管理 > サーバスクリプト」タブで「新規作成」を選択する。
 2-2:タイトル: 任意の名前(例:fillLinkFromSiteId)
 2-3:スクリプト: 下記サンプルコードを貼り付け
 2-4:条件: 「計算式の後」にチェック

JavaScript

条件:計算式の後

// サイト ID を入れる項目(数値A)と、サイトの名前・種類を入れる項目
const SITE_ID_COLUMN = 'NumA';
const NAME_COLUMN = 'Title';
const TYPE_COLUMN = 'ClassA';
// サイトの種類(items.NewSite のパラメータの説明にある値)と、画面に出す名前
const TYPE_NAMES = {
    Sites: 'フォルダ',
    Issues: '期限付きテーブル',
    Results: '記録テーブル',
    Wikis: 'Wiki',
    DashBoard: 'ダッシュボード'
};

// リンク集のレコードにサイト ID を入れて保存したとき、そのサイトの名前と種類を入れる。
// 名前を手で写さないので、サイトの名前を変えたあとも、保存し直すと新しい名前になる
function fillLinkFromSiteId() {
    const siteId = Number(model[SITE_ID_COLUMN]);
    if (!siteId) {
        return;
    }
    const sites = Array.from(items.GetSite(siteId));
    if (sites.length === 0) {
        // 取得できないときは、名前と種類を変えずに知らせる
        context.AddMessage(`サイト ID ${siteId} のサイトを取得できません。`, 'alert-warning');
        return;
    }
    model[NAME_COLUMN] = sites[0].Title;
    model[TYPE_COLUMN] = TYPE_NAMES[sites[0].ReferenceType] || sites[0].ReferenceType;
}

fillLinkFromSiteId();

注記

  • サイトを取得できないときは、名前と種類を変えずに、画面の下部にメッセージを出します。保存は止めません。

関連情報