ユーザマニュアル




2024/06/11

MANUAL

開発者向け機能:サーバスクリプト:items.GetClosestSite

## 概要 [itemsオブジェクト](/ja/manual/server-script-items)の「GetClosestSiteメソッド」です。[サイト名検索](/ja/manual/api-site-get-closest-siteid)で該当サイトに最も近いサイト情報を取得します。 ## 前提条件 1. 本機能はサイトの「サイト名」を検索します。あらかじめサイト名を設定してください。サイトの[タイトル](/ja/manual/tenant-logo)ではありませんので注意ください。 ![image](https://pleasanter.org/binaries/be2492d00d0c4ee0b48cd62f3356ac73) ## 構文 ``` items.GetClosestSite(name,id) ``` ## パラメータ |パラメータ|型|必須|説明| |:----------|:----------|:---:|:---------------------------| |name|string|○|サイト名を指定| |id|int||検索開始サイトIDを指定(省略時:サーバスクリプトが格納されたサイトID)| ## 戻り値 該当するサイトの[apiModel](/ja/manual/server-script-api-model)を返却します。 見つからなかった場合またはアクセス権が無い場合はnullを返却します。 ## 使用例 以下の例では、サイト名が "WBS" のサイト情報を取得します。 ``` const site = items.GetClosestSite('WBS'); if (site) { context.Log(site.SiteId); context.Log(site.Title); context.Log(site.ReferenceType); } ``` ## 使用例① 以下の例では、[サーバスクリプト](/ja/manual/table-management-server-script)が格納されたサイトからサイト名”WBS”で検索したサイト情報を取得します。 ``` const site = items.GetClosestSite('WBS'); ``` ## 使用例② 以下の例では、サイトIDが1234のサイトからサイト名”WBS”で検索したサイト情報を取得します。 [バックグラウンドサーバスクリプト](/ja/manual/background-server-script)ではこちらを使用します。 ``` const site = items.GetClosestSite('WBS',1234); ``` ## 補足 [開発者向け機能:サーバスクリプト:items.GetSiteByName](/ja/manual/server-script-items-get-site-by-name)との違いは、items.GetSiteByNameメソッドは該当サイト名を持つ全てのサイトを返しますが、item.GetClosestSiteメソッドは検索開始サイトから最近傍の該当サイト名を持つサイトを1つ返します。 ## 関連情報 <div id="ManualList"><ul><li><a href="/ja/manual/table-management-server-script">テーブルの管理:サーバスクリプト</a><span>2024/10/08 up</span></li></ul></article> <ul><li><a href="/ja/manual/tenant-logo">テナント管理機能:ロゴ、タイトル、ロゴ画像</a><span>2024/04/11 up</span></li> <li><a href="/ja/manual/background-server-script">テナント管理機能:バックグラウンドサーバスクリプト</a><span>2024/06/17 up</span></li></ul></article> <ul><li><a href="/ja/manual/api-site-get-closest-siteid">開発者向け機能:API:サイト操作:サイト名検索で該当サイトに最も近いサイトID取得</a><span>2024/06/11 up</span></li></ul></article> <ul><li><a href="/ja/manual/script-api-get-closest-siteid">開発者向け機能:スクリプト:$p.apiGetClosestSiteId</a><span>2024/06/17 up</span></li></ul></article> <ul><li><a href="/ja/manual/server-script">開発者向け機能:サーバスクリプト</a><span>2023/06/01 up</span></li> <li><a href="/ja/manual/server-script-items">開発者向け機能:サーバスクリプト:items</a><span>2024/06/11 up</span></li> <li><a href="/ja/manual/server-script-api-model">開発者向け機能:サーバスクリプト:apiModel</a><span>2023/06/30 up</span></li> <li><a href="/ja/manual/server-script-api-model-create">開発者向け機能:サーバスクリプト:apiModel.Create</a><span>2024/05/02 up</span></li> <li><a href="/ja/manual/server-script-api-model-update">開発者向け機能:サーバスクリプト:apiModel.Update</a><span>2023/06/23 up</span></li></ul></article> <ul><li><a href="/ja/manual/faq-server-script-log">FAQ:サーバスクリプトのエラーログを出力したい</a><span>2024/04/29 up</span></li> <li><a href="/ja/manual/faq-get-closest-site-logic">FAQ:サイト名検索で該当サイトに最も近いサイトID取得の検索順が知りたい。</a><span>2024/06/11 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />
TOP
このページをシェアする
記載された商品名、各製品名は各社の登録商標または商標です。 © Implem Inc.