サイト名検索で該当サイトに最も近いサイトID取得

2026-09-172026-09-17

概要¶

APIを使用して「サイト名検索」で該当サイトに最も近いサイトIDを取得する事ができます。

前提条件¶

本機能はサイトの「サイト名」を検索します。あらかじめサイト名を設定してください。サイトのタイトルではありませんので注意ください。

事前準備¶

APIの操作を行う前にAPIキーの作成を実施してください。また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。

リクエスト¶

下記のリクエスト形式で、JSONデータを送信します。

設定項目	値
HTTPメソッド	POST
Content-Type	application/json
文字コード	UTF-8
URL	http://{サーバー名}/api/items/{サイトID}/getclosestsiteid ¹
Body	以下のjsonデータを参考のこと

JSON
{
    "ApiVersion": "1.1",
    "ApiKey": "345yuAjA6789dA09d8uj6...",
    "FindSiteNames": [
        "SiteName1",
        "SiteName2"
    ]
}

FindSiteNamesについて¶

検索したい対象のサイト名を配列で指定します。

以下の例ではサイト名が"ParentSite","HideSite"を検索します。

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

対応バージョン¶

対応バージョン	内容
1.4.5.0以降	機能追加