## 概要 APIを使用して[サイト名検索](/ja/manual/script-api-get-closest-siteid)で該当サイトに最も近いサイトIDを取得する事ができます。 ## 前提条件 1. 本機能はサイトの「サイト名」を検索します。あらかじめサイト名を設定してください。サイトの[タイトル](/ja/manual/tenant-logo)ではありませんので注意ください。  ## 事前準備 APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。 ## リクエスト 下記のリクエスト形式で、jsonデータを送信します。 |設定項目|値| |:--|:--| |HTTPメソッド|POST| |Content-Type |application/json| |文字コード|UTF-8| |URL|http://{サーバー名}/api/items/{サイトID}/getclosestsiteid(※１)| |Body|以下のjsonデータを参考のこと| (※1){サーバー名}、{サイトID}の部分は、適宜、環境に合わせて編集してください。 　　pleasanter.netの場合は以下の形式になります。 　　https\://pleasanter.net/fs/api/items/{サイトID}/getclosestsiteid 　　{サイトID}には、サイト検索を開始する対象のサイトを指定してください。 ##### JSON ``` { "ApiVersion": "1.1", "ApiKey": "345yuAjA6789dA09d8uj6...", "FindSiteNames":["SiteName1","SiteName2"] } ``` #### FindSiteNamesについて 1. 検索したい対象のサイト名を配列で指定します。 以下の例ではサイト名が"ParentSite","HideSite"を検索します。 ##### JSON ```json { "ApiVersion": 1.1, "ApiKey": "345yuAjA6789dA09d8uj6...", "FindSiteNames":["ParentSite","HideSite"] } ``` ## レスポンス 下記の形式のjsonデータが返却されます。 ##### JSON ``` { "SiteId": 12345, "Data": [ { "SiteName": "ParentSite", "SiteId": 12344 }, { "SiteName": "HideSite", "SiteId": -1 } ] } ``` 検索対象サイト名と対となるSiteIdが返されます。 見つからなかった場合またはアクセス権が無い場合は-1を返却します。 スクリプトでの使用方法は、以下のマニュアルをご参照ください。 [開発者向け機能：スクリプト：$p.apiGetClosestSiteid](/manual/script-api-get-closest-siteid) ## 対応バージョン |No|内容|対応バージョン| |:--:|:--|:--| |1|機能追加|1.4.5.0以降| ## 関連情報 ・[FAQ：サイト名検索で該当サイトに最も近いサイトID取得の検索順が知りたい。](/manual/faq-get-closest-site-logic)