ユーザマニュアル




2024/06/17

MANUAL

開発者向け機能:スクリプト:$p.apiGetClosestSiteId

## 概要 AjaxのPOSTリクエストによる[サイト名検索](/ja/manual/api-site-get-closest-siteid)で該当サイトに最も近いサイトIDを取得するスクリプト機能です。 ## 前提条件 1. 本機能はサイトの「サイト名」を検索します。あらかじめサイト名を設定してください。サイトの[タイトル](/ja/manual/tenant-logo)ではありませんので注意ください。 ![image](https://pleasanter.org/binaries/be2492d00d0c4ee0b48cd62f3356ac73) ## 構文 ##### JavaScript ``` $p.apiGetClosestSiteId({ id: <検索開始のサイトID>, data: { <取得条件> }, done: <任意の処理>, fail: <任意の処理>, always: <任意の処理> }); ``` ## 各パラメータの説明 |パラメータ名|説明|必須| |:--|:--|:--:| |id|検索開始のサイトID。通常は $p.siteId() を使用して、このメソッドを呼び出しているサイトのIDを指定します。|○| |data|取得条件|○| |done|API通信成功|○| |fail|API通信失敗|-| |always|完了時|-| ## 取得条件について |キーワード|説明|必須| |:--|:--|:--:| |FindSiteNames|検索したい対象のサイト名を配列で指定。|○| ## 使用例 ### 呼び出し ##### JavaScript ``` $p.apiGetClosestSiteId({ id: $p.siteId(), data: { FindSiteNames:['ParentSite','HideSize'] }, done: function (data) { console.log(data); } }); ``` ### レスポンス ##### JavaScript ``` { "SiteId": 12345, "Data": [ { "SiteName": "ParentSite", "SiteId": 12344 }, { "SiteName": "HideSite", "SiteId": -1 } ] } ``` ## 関連情報 <div id="ManualList"><ul><li><a href="/ja/manual/tenant-logo">テナント管理機能:ロゴ、タイトル、ロゴ画像</a><span>2024/04/11 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/server-script-items-get-closest-site">開発者向け機能:サーバスクリプト:items.GetClosestSite</a><span>2024/06/11 up</span></li></ul></article> <ul><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.