機械翻訳について
  1. サイト管理用のREST API
  2. タスク
  3. 設定

サイト管理設定リソースを編集するためのリクエスト本文の例の取得

get

/sites/management/api/v1/settings/edit-form

EDIT FORM

サイト管理設定インスタンスの編集に適したテンプレート・リクエスト本文を取得します。edit-formリソースは、Sites Management Settingsの編集時に更新可能なプロパティを決定するためのテンプレートとしてクライアントに使用されます。レスポンスには、編集可能なすべてのプロパティ値が含まれます。 これらのプロパティを編集または破棄し、Sites Management Settingsを編集するためのリクエスト本文として使用できます。

リリース20.1.2で導入されました。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK

リクエスト

GET https://api.example.com/sites/management/api/v1/settings/edit-form

レスポンス本文

{
  "allowSiteCreation": false,
  "governanceEnabled": false,
  "siteSecurityPolicy": {
    "level": "service",
    "appliesTo": "named"
  },
  "siteAdminOnlyOperations": {
    "siteCreation": false,
    "templateCreation": false,
    "themeCreation": false,
    "componentCreation": false
  },
  "prerender": {
    "enabled": false,
    "userAgents": "AdsBot-Google,AdsBot-Google-Mobile-Apps,AppEngine-Google"
  },
  "expiration": {
    "action": "nothing",
    "deleteAfter": 30
  }
}

リクエスト

問合せパラメータ

  • レスポンスに含めないフィールド名のカンマ区切り文字列。

  • レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。

  • レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。

  • レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。

    次のリンクは、このリソースにより提供されます:

    リンク関係説明
    parent親リソースが読取り可能な場所を示します。 このリンクはupリンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
    selfリソースの現在の戻り表現を示します。 リソース自体を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
    canonicalリクエストされたリソースの優先表現を示します。 リソースの標準的な形式を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
    editリソースを編集できる場所について説明します。 単一のリソースで使用され、既存のリソースを編集するためにパッチを実行できる場所を示します。
    describedByリソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。 スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。
トップに戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

OK
ヘッダー
本文()
ルート・スキーマ: schema
型: object
ソースを表示

  • サービス・ユーザーにサイトの作成を許可します。 サイトを作成する機能を有効にすると、すべてのユーザーがテンプレートおよびサイトを作成できるようになります。 サイトの作成を無効化しても、ユーザーは、階層内のテンプレートおよび他のフォルダを表示し操作できます。 また、サイトを共有している場合、既存のサイトを操作できます。 ロールに応じて、サイトを表示、編集および管理できます。 サイト機能を有効にした場合、ユーザーは、機密情報を含め、自分がアクセス権を持つコンテンツを公開できます。 ユーザーをセキュアなサイトのみの作成に制限できます。これにより、ユーザーはサイトのコンテンツを表示する前にサインインしなければならなくなります。 さらにセキュリティを高めるために、サイトの作成を管理者に限定できます。

    リリース20.1.2で導入されました。
  • expiration

    サイトの失効設定(サイトの失効時にサイトが自動的にオフラインにされ削除されるかどうかなど)。

    リリース20.3.1で導入されました。

  • サイトのガバナンスを有効にして、サイト管理者ではないビジネス・ユーザーのサイト配信を簡略化および高速化し、サイト管理者が一元化されたロケーションからサイトを簡単に制御および追跡できるようにします。

    リリース20.1.2で導入されました。
  • links

    このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

  • prerender

    サービス設定(サービスが有効かどうかなど)。

    リリース20.1.2で導入されました。
  • siteAdminOnlyOperations

    サイト、テンプレート、テーマおよびコンポーネントの作成をサイト管理者に制限します。

    リリース20.1.2で導入されました。
  • siteSecurityPolicy

    オンライン・サイトで許可される最小セキュリティを指定します。

    リリース20.1.2で導入されました。
ネストされたスキーマ : 有効期限
型: object

サイトの失効設定(サイトの失効時にサイトが自動的にオフラインにされ削除されるかどうかなど)。

リリース20.3.1で導入されました。
ソースを表示

  • サイトの期限が切れたときに実行するアクション。 これは何もできない可能性があります。 サイトがオンラインの場合、サイトはオンラインのままになります。 非アクティブ化アクションは、サイトの期限が切れた後にサイトをオフラインにします。 サイトの期限が切れてサイトも削除されると、削除アクションはサイトをオフラインにします。 サイトは、サイトが削除されるまでの失効後の期間を判断するために、翌日を使用して削除されます。

    有効な値は次のとおりです。

    • nothing - サイトはオンラインのままなので削除されません
    • deactivate - サイトは、サイトの期限が切れるとオフラインになります
    • delete - サイトは、有効期限が切れた後に構成可能な日数後にサイトの期限が切れるとオフラインになります

    リリース20.3.1で導入されました。
  • 最小値: 3
    最大値: 90

    サイトを削除する前に、サイトが失効してから待機する日数。 この設定は、選択したアクションが期限切れサイトを削除する場合にのみ使用されます。 サイトの削除が無効になっている場合、この設定は引き続き設定できます。設定値は無視されます。

    リリース20.3.1で導入されました。
ネストされたスキーマ: links
型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示
ネストされたスキーマ : prerender
型: object

サービス設定(サービスが有効かどうかなど)。

リリース20.1.2で導入されました。
ソースを表示

  • Prerenderサービスを有効または無効にします。

    リリース20.1.2で導入されました。

  • 検出されると、クライアント(クローラおよびボット)がレンダリング前に生成されたキャッシュ済サイト・コンテンツにリダイレクトされるユーザー・エージェント製品名のカンマ区切りリスト。 Oracle Content Managementには、このカスタム・ユーザー・エージェント製品名と組み合せたクローラおよびボットのリストが組み込まれています。

    リリース20.1.2で導入されました。
ネストされたスキーマ : siteAdminOnlyOperations
型: object

サイト、テンプレート、テーマおよびコンポーネントの作成をサイト管理者に制限します。

リリース20.1.2で導入されました。
ソースを表示

  • Trueの場合、サイト管理者のみがコンポーネントを作成できます。

    リリース20.1.2で導入されました。

  • Trueの場合、サイト管理者のみがサイトを作成できます。 ガバナンスが有効な場合は無視されます。

    リリース20.1.2で導入されました。

  • Trueの場合、サイト管理者のみがテンプレートを作成できます。

    リリース20.1.2で導入されました。

  • Trueの場合、サイト管理者のみがテーマを作成できます。

    リリース20.1.2で導入されました。
ネストされたスキーマ : siteSecurityPolicy
型: object

オンライン・サイトで許可される最小セキュリティを指定します。

リリース20.1.2で導入されました。
ソースを表示

  • サイトにアクセス可能なユーザーのタイプを定義します。 すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。

    有効な値は次のとおりです。

    • named - 指定されたレベル内の指定ユーザーのみがアクセスできます
    • all - 指定されたレベル内のすべてのユーザーがアクセスできます

  • サイトに設定できる最大オープン・セキュリティ・レベル。

    有効な値は次のとおりです。

    • service - サービス・ユーザーのみ
    • cloud - ドメインにサインインできるクラウド・ユーザーのみ
    • everyone - サインインせずに誰でも

ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 「リンク」
レスポンスの例 ()
{
    "allowSiteCreation":false,
    "governanceEnabled":false,
    "siteSecurityPolicy":{
        "level":"service",
        "appliesTo":"named"
    },
    "siteAdminOnlyOperations":{
        "siteCreation":false,
        "templateCreation":false,
        "themeCreation":false,
        "componentCreation":false
    },
    "prerender":{
        "enabled":false,
        "userAgents":"AdsBot-Google,AdsBot-Google-Mobile-Apps,AppEngine-Google"
    },
    "expiration":{
        "action":"nothing",
        "deleteAfter":30
    }
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

406レスポンス

受入れられない

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト
先頭に戻る