コンテンツにスキップ

items.GetSiteByTitle

概要

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

制限事項

1.5.10.0

  1. 取得するサイトの「サイトの管理権限」が無いユーザ(特権ユーザを除く)が実行した場合、SiteSettings(項目のラベルや選択肢などのサイトの設定)は取得できません。テナント管理者であっても、サイトの管理権限が無い場合は同じです。SiteIdやTitleなどのサイトの情報は取得できます。SiteSettingsを参照する処理では、値があることを確かめてから使用してください。

構文

items.GetSiteByTitle(title)

パラメータ

パラメータ 型 必須 説明
title object ○ サイトのタイトルを指定

戻り値

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

バージョン1.5.10.0以降では、SiteSettingsの「AI連携」の設定に含まれるAPIキーは、マスクした文字列********です。

使用例

以下の例では、タイトルが "部署マスタ" のサイト情報を取得してログに出力します。

const sites = Array.from(items.GetSiteByTitle('部署マスタ'));
if (sites.length) {
    sites.forEach(site => {
        context.Log(site.SiteId);
        context.Log(site.Title);
        context.Log(site.ReferenceType);
    })
}

サンプルコード

1. 年度ごとに作ったテーブルを名前で探し、金額の合計を入れる

「受注実績_2025」「受注実績_2026」のように年度ごとにテーブルを作っている場合に、「年度別集計」のレコードに年度を入れて保存すると、「受注実績_」+年度の名前のテーブルをitems.GetSiteByTitleで探し、そのテーブルの金額の合計を入れます。

実務での使いどころ

年度ごとにテーブルを作り直す運用で、年度が替わるたびにスクリプトのサイトIDを書き換えずに済ませたいときに使えます。サイトIDをコードに書かないので、開発の環境で作ったスクリプトを、サイトIDの違う本番の環境へそのまま持っていけます。サマリやリンクは、決めたテーブルとの間でしか集計できません。

事前準備

1:年度ごとのテーブル(「受注実績_2025」「受注実績_2026」など)で、数値A(NumA)を金額として有効化してください。

2:「年度別集計」テーブル(記録テーブル)で、以下の項目を有効化してください。

項目コード 内容
数値A(NumA) 金額の合計
数値B(NumB) 年度(例:2026)

3:「年度別集計」テーブルにスクリプトを登録します。

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

JavaScript

条件:計算式の後

// 年度ごとに作ったテーブルの名前の前半(「受注実績_2026」なら「受注実績_」)
const TABLE_PREFIX = '受注実績_';
// 年度(数値B)と、合計を入れる項目(数値A)、合計する項目(各年度のテーブルの数値A)
const YEAR_COLUMN = 'NumB';
const TOTAL_COLUMN = 'NumA';
const AMOUNT_COLUMN = 'NumA';

// 年度を入れて保存したとき、その年度のテーブルを名前で探し、金額の合計を入れる。
// サイト ID をコードに書かないので、年度が替わっても、開発と本番でサイト ID が違っても、コードを直さずに使える
function sumYearlyTable() {
    const year = Number(model[YEAR_COLUMN]);
    if (!year) {
        return;
    }
    const title = `${TABLE_PREFIX}${year}`;
    const sites = Array.from(items.GetSiteByTitle(title));
    if (sites.length !== 1) {
        // 見つからない・同じ名前のテーブルが複数あるときは、合計を変えずに知らせる
        context.AddMessage(
            sites.length === 0 ? `「${title}」のテーブルが見つかりません。` : `「${title}」という名前のテーブルが${sites.length}つあります。`,
            'alert-warning'
        );
        return;
    }
    model[TOTAL_COLUMN] = items.Sum(sites[0].SiteId, AMOUNT_COLUMN);
}

sumYearlyTable();

注記

  • 同じ名前のテーブルが複数あるときと、見つからないときは、合計を変えずにメッセージを出します。保存は止めません。

対応バージョン

対応バージョン 内容
1.5.10.0 以降 サイトの管理権限が無いユーザが実行した場合、SiteSettingsを取得できないよう変更
AI連携のAPIキーを、マスクした文字列で返すよう変更

関連情報