コンテンツにスキップ

$p.apiGetSite

概要

AjaxのPOSTリクエストにより、サイト情報を取得します。

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

制限事項

1.5.10.0

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

構文

JavaScript
$p.apiGetSite({
    id: <取得対象のサイトID>,
    done: <任意の処理>,
    fail: <任意の処理>,
    always: <任意の処理>
});

各パラメータの説明

パラメータ名 説明 必須
id 取得対象のサイトID ○
done API通信成功 ○
fail API通信失敗 -
always 完了時 -

使用例

JavaScript
$p.apiGetSite({
    id: 123,
    done: function (data) {
        console.log(data);
        console.log('サイト情報の取得に成功しました。');
    },
    fail: function () {
        console.log('サイト情報の取得に失敗しました。');
    },
    always: function () {
        console.log('サイト情報の取得が完了しました。');
    }
});

サンプルコード

1. サイト廃止申請のレコードから、確認のうえサイトを削除する

このサンプルは「$p.apiDeleteSite」のサンプルコードにあります。

対応バージョン

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

関連情報