すべての設定を取得
リクエスト
GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/settings?fields=string&$skip=int&$top=int&query=string
パラメーター | 説明 |
|---|---|
| オプション。各設定の指定されたフィールドのサブセットのみを返します。サブセットを定義するには、フィールド構文を使用します。 |
| オプション。最初の設定を返す前にスキップする設定数を設定できます。 |
| オプション。返される設定の最大数を設定できます。 |
| オプション。検索クエリを指定して、返される結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。設定では、以下のフィールドとタプルがサポートされています。 id : value — 指定された ID の設定 type : public — 公開設定を取得する type : internal — 内部設定を取得する type : smtp — SMTP 設定を取得する type : backup — バックアップ設定を取得する |
レスポンス
レスポンスコード | 意味 |
|---|---|
200 OK | リクエストが成功しました。 |
400 不正な要求 | リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。 |
403 禁止します | 要求元は、要求されたリソースにアクセスできません。 |
404 お探しのページが見つかりませんでした | 要求されたリソースが見つかりませんでした。 |
500 内部サーバーエラー | サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。 |
レスポンスボディ
{
"skip": int,
"top": int,
"total": int,
"settings": [[[[settings|HUB-REST-API_JSON-Scheme.html#settings]]], ...]
}
2025 年 3 月 24 日
