サイト管理用のREST API

機械翻訳について

サイト管理設定の更新

patch

/sites/management/api/v1/settings

SINGULAR

複数のサイト管理設定のいずれかを更新します。設定は個別に変更することも、まとめて変更することもできます。

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

認可

この操作を起動するには、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが次のいずれかのロールを持っている必要があります:

CECServiceAdministrator

成功したレスポンスの例

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

200OK - Disable Site Governance

サイト・ガバナンスを無効にして、テンプレートのすべてのメンバーがサイトを作成できるようにします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "governanceEnabled": false
}

200 OK - サイト・ガバナンスの有効化

サイト・ガバナンスを有効にして、サイトを作成できるユーザーやサイト作成を承認できるユーザーを管理できるようにします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "governanceEnabled": true
}

200 OK - サイト・プリンタ・サービスの無効化

レンダー・サービスを無効にします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "prerender": {
    "enabled": false
  }
}

200 OK - サイト・プレレンダ・サービスの有効化

サイト・アクセスが最適化されるように、サイト・レンダリング・サービスを有効にします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "prerender": {
    "enabled": true
  }
}

200 OK - 非サイト管理者によるサイト作成の許可

サービス・ユーザーによるサイトの作成を許可します。サイト・ガバナンスが有効なサイト作成の場合、この設定は無視され、サイト作成はサイト管理者が管理するポリシーによって制御されます。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "allowSiteCreation": true
}

200 OK - サイト作成の防止

誰でもサイトを作成できないようにします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "allowSiteCreation": false
}

200 OK - 最小サイト・セキュリティの変更

オンライン・サイトの最小サイト・セキュリティ設定を変更します。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "siteSecurityPolicy": {
    "level": "service",
    "appliesTo": "named"
  }
}

200 OK - コンポーネントおよびテーマを作成できるユーザーの変更

制限された操作を変更して、非サイト管理者がコンポーネントおよびテーマを作成できるようにします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "siteAdminOnlyOperations": {
    "themeCreation": false,
    "componentCreation": false
  }
}

200 OK - 失効時のサイトの非アクティブ化

サイトが期限切れになると、自動的にサイトをオフラインにします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "expiration": {
    "action": "deactivate"
  }
}

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

200 OK - 失効時にサイトを削除

サイトの有効期限が切れたら自動的にサイトをオフラインにし、サイトの有効期限が切れた10日後にサイトを削除します。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/settings

リクエスト本文

{
  "expiration": {
    "action": "delete",
    "deleteAfter": 10
  }
}

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

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

400Bad Request - Invalid Security Scope

サイト・セキュリティ・スコープnamedは、everyoneのセキュリティ・レベルでは使用できません。 everyoneのセキュリティ・レベルを使用する場合は、allのサイト・セキュリティ・スコープを使用する必要があります。

エラー・コード

OCE-SITEMGMT-009018

解決 - サイト・セキュリティ・スコープの編集

セキュリティ・スコープを推奨される必須スコープ値に変更します。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名	説明
`level`	指定されたサイト・セキュリティ・レベル。有効な値は次のとおりです。 `service` - サービス・ユーザーのみ `cloud` - ドメインにサインインできるクラウド・ユーザーのみ `everyone` - サインインせずに誰でも
`specifiedScope`	指定したサイト・セキュリティ範囲。有効な値は次のとおりです。 `named` - 指定されたレベル内の指定ユーザーのみがアクセスできます `all` - 指定されたレベル内のすべてのユーザーがアクセスできます
`requiredScope`	必須のサイト・セキュリティ・スコープです。有効な値は次のとおりです。 `named` - 指定されたレベル内の指定ユーザーのみがアクセスできます `all` - 指定されたレベル内のすべてのユーザーがアクセスできます

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidSecurityScopeExceptionDetailスキーマを参照してください。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Security Scope",
  "status": "400",
  "detail": "Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
  "o:errorCode": "OCE-SITEMGMT-009018",
  "level": "service",
  "specifiedScope": "named",
  "requiredScope": "all"
}

409競合 - Starter Editionガバナンスはサポートされていません

Starter Editionでは、1つのサイトのみを作成できます。

エラー・コード

OCE-SITEMGMT-009119

解決 - Premiumにアップグレード

Premiumにアップグレードして、サイト・ファクトリ・ガバナンスにアクセスします。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Starter Edition Governance Not Supported",
  "status": "409",
  "detail": "Site governance is not supported in Starter Edition.",
  "o:errorCode": "OCE-SITEMGMT-009119"
}

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

リクエスト

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

application/merge-patch+json

更新対象のプロパティのみをリクエストに指定してください。プロパティを削除するには、値をnullに指定してリクエストに含めます。更新できないプロパティは無視されます。

ルート・スキーマ: schema

型: object

ソースを表示

allowSiteCreation(optional): boolean

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

サイトの失効設定(サイトの失効時にサイトが自動的にオフラインにされ削除されるかどうかなど)。
リリース20.3.1で導入されました。
governanceEnabled(optional): boolean

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

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

サービス設定(サービスが有効かどうかなど)。
リリース20.1.2で導入されました。
siteAdminOnlyOperations(optional): object siteAdminOnlyOperations

サイト、テンプレート、テーマおよびコンポーネントの作成をサイト管理者に制限します。
リリース20.1.2で導入されました。
siteSecurityPolicy(optional): object siteSecurityPolicy

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

{
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "allowSiteCreation":{
            "description":"<p>Allow your service users to create sites. When you enable the ability to create sites, you allow all users to create templates and sites. If you disable site creation, users can still see and work with templates and other folders in the hierarchy. Users can also still work with an existing site if the site is shared with them. They can view, edit, and manage the site, depending on their role. When you enable sites functionality, users have the ability to publish any content they have access to, including confidential information. You might want to limit your users to creating only secured sites, so that users have to sign in before they can see the site content. For even more security, you can limit site creation to administrators.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "governanceEnabled":{
            "description":"<p>Enable governance for sites to simplify and accelerate site delivery for business users, who are not site administrators, while giving site administrators an easy way to control and track sites from a centralized location.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "siteSecurityPolicy":{
            "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "level":{
                    "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "appliesTo":{
                    "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        },
        "siteAdminOnlyOperations":{
            "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "siteCreation":{
                    "description":"<p>If true, only site administrators can create sites. Ignored if governance is enabled.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "templateCreation":{
                    "description":"<p>If true, only site administrators can create templates.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "themeCreation":{
                    "description":"<p>If true, only site administrators can create themes.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "componentCreation":{
                    "description":"<p>If true, only site administrators can create components.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                }
            }
        },
        "prerender":{
            "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "enabled":{
                    "description":"<p>Enable or disable the Prerender Service.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "userAgents":{
                    "description":"<p>Comma-separated list of user-agent product names that, if detected, will cause the client (crawlers and bots) to be redirected to the pre-render generated cached site content. Oracle Content Management has a built in list of crawlers and bots with is combined with this custom user-agent product names.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        },
        "expiration":{
            "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "action":{
                    "description":"<p>What action to take when the site expires. This can be do nothing. If the site is online the site will remain online. The deactivate action takes the site offline after the site expires. The delete action takes the site offline after the site expires and also deletes the site. The site is deleted using the days after to determine how long after expiration before the site is deleted.</p><p>Valid values are:\n<ul><li> <code>nothing</code> - Site is left online and is not deleted</li><li> <code>deactivate</code> - Site is taken offline when the site expires</li><li> <code>delete</code> - Site is taken offline when the site expires and deleted after a configurable number of days after expiration</li></p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "deleteAfter":{
                    "description":"<p>Number of days to wait after a site expires before deleting the site. This setting is only used if the action selected is to delete expired sites. This setting can still be set if site deletion is disabled; the setting value will just be ignored. </p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32",
                    "maximum":90,
                    "minimum":3
                }
            }
        }
    },
    "example":{
        "governanceEnabled":false
    }
}

例:

{
    "governanceEnabled":false
}

ネストされたスキーマ : 有効期限

型: object

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

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

ソースを表示

action(optional): string
サイトの期限が切れたときに実行するアクション。これは何もできない可能性があります。サイトがオンラインの場合、サイトはオンラインのままになります。非アクティブ化アクションは、サイトの期限が切れた後にサイトをオフラインにします。サイトの期限が切れてサイトも削除されると、削除アクションはサイトをオフラインにします。サイトは、サイトが削除されるまでの失効後の期間を判断するために、翌日を使用して削除されます。
有効な値は次のとおりです。
- nothing - サイトはオンラインのままなので削除されません
- deactivate - サイトは、サイトの期限が切れるとオフラインになります
- delete - サイトは、有効期限が切れた後に構成可能な日数後にサイトの期限が切れるとオフラインになります
リリース20.3.1で導入されました。
deleteAfter(optional): integer(int32)

最小値: 3

最大値: 90

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

{
    "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "action":{
            "description":"<p>What action to take when the site expires. This can be do nothing. If the site is online the site will remain online. The deactivate action takes the site offline after the site expires. The delete action takes the site offline after the site expires and also deletes the site. The site is deleted using the days after to determine how long after expiration before the site is deleted.</p><p>Valid values are:\n<ul><li> <code>nothing</code> - Site is left online and is not deleted</li><li> <code>deactivate</code> - Site is taken offline when the site expires</li><li> <code>delete</code> - Site is taken offline when the site expires and deleted after a configurable number of days after expiration</li></p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "deleteAfter":{
            "description":"<p>Number of days to wait after a site expires before deleting the site. This setting is only used if the action selected is to delete expired sites. This setting can still be set if site deletion is disabled; the setting value will just be ignored. </p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32",
            "maximum":90,
            "minimum":3
        }
    }
}

ネストされたスキーマ: links

型: array

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

ソースを表示

Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

ネストされたスキーマ : prerender

型: object

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

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

ソースを表示

enabled(optional): boolean

Prerenderサービスを有効または無効にします。
リリース20.1.2で導入されました。
userAgents(optional): string

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

{
    "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "enabled":{
            "description":"<p>Enable or disable the Prerender Service.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "userAgents":{
            "description":"<p>Comma-separated list of user-agent product names that, if detected, will cause the client (crawlers and bots) to be redirected to the pre-render generated cached site content. Oracle Content Management has a built in list of crawlers and bots with is combined with this custom user-agent product names.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ : siteAdminOnlyOperations

型: object

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

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

ソースを表示

componentCreation(optional): boolean

Trueの場合、サイト管理者のみがコンポーネントを作成できます。
リリース20.1.2で導入されました。
siteCreation(optional): boolean

Trueの場合、サイト管理者のみがサイトを作成できます。ガバナンスが有効な場合は無視されます。
リリース20.1.2で導入されました。
templateCreation(optional): boolean

Trueの場合、サイト管理者のみがテンプレートを作成できます。
リリース20.1.2で導入されました。
themeCreation(optional): boolean

Trueの場合、サイト管理者のみがテーマを作成できます。
リリース20.1.2で導入されました。

{
    "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "siteCreation":{
            "description":"<p>If true, only site administrators can create sites. Ignored if governance is enabled.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "templateCreation":{
            "description":"<p>If true, only site administrators can create templates.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "themeCreation":{
            "description":"<p>If true, only site administrators can create themes.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "componentCreation":{
            "description":"<p>If true, only site administrators can create components.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : siteSecurityPolicy

型: object

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

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

ソースを表示

appliesTo(optional): string
サイトにアクセス可能なユーザーのタイプを定義します。すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。
有効な値は次のとおりです。
- named - 指定されたレベル内の指定ユーザーのみがアクセスできます
- all - 指定されたレベル内のすべてのユーザーがアクセスできます
level(optional): string
サイトに設定できる最大オープン・セキュリティ・レベル。
有効な値は次のとおりです。
- service - サービス・ユーザーのみ
- cloud - ドメインにサインインできるクラウド・ユーザーのみ
- everyone - サインインせずに誰でも

{
    "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "level":{
            "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "appliesTo":{
            "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: items

すべてに一致

ソースを表示

object 「リンク」

REST HATEOASリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

ネストされたスキーマ: Link

型: object

REST HATEOASリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

ソースを表示

href(optional): string

ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。
mediaType(optional): string

メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
method(optional): string
リンクのターゲットをリクエストするためのHTTPメソッド。
有効な値は次のとおりです。
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
profile(optional): string(uri)

ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
rel(optional): string

リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、falseとみなすことができます。

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

トップに戻る

レスポンス

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

application/json
application/vnd.oracle.resource+json;type=singular

200レスポンス

ヘッダー

Cache-Control: string

キャッシュ・メカニズムのディレクティブ。
Content-Length: string

レスポンス本文のサイズ。
Content-Type: string

レスポンスのコンテンツ・タイプ。

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf SitesManagementSettings

サイト管理の設定。
リリース20.1.2で導入されました。

{
    "allOf":[
        {
            "$ref":"#/definitions/SitesManagementSettings"
        }
    ]
}

ネストされたスキーマ : SitesManagementSettings

サイト管理の設定。

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

すべてに一致

ソースを表示

object SingularResource

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
object SitesManagementSettings-allOf[1]

{
    "description":"<p>Sites Management settings.</p><small>Introduced in release 20.1.2.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "allowSiteCreation":{
                    "description":"<p>Allow your service users to create sites. When you enable the ability to create sites, you allow all users to create templates and sites. If you disable site creation, users can still see and work with templates and other folders in the hierarchy. Users can also still work with an existing site if the site is shared with them. They can view, edit, and manage the site, depending on their role. When you enable sites functionality, users have the ability to publish any content they have access to, including confidential information. You might want to limit your users to creating only secured sites, so that users have to sign in before they can see the site content. For even more security, you can limit site creation to administrators.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "governanceEnabled":{
                    "description":"<p>Enable governance for sites to simplify and accelerate site delivery for business users, who are not site administrators, while giving site administrators an easy way to control and track sites from a centralized location.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "siteSecurityPolicy":{
                    "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SecurityPolicy"
                        }
                    ]
                },
                "siteAdminOnlyOperations":{
                    "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteAdminOnlyOperations"
                        }
                    ]
                },
                "prerender":{
                    "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/PrerenderSettings"
                        }
                    ]
                },
                "expiration":{
                    "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteExpirationSettings"
                        }
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : SingularResource

型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示

links(optional): array links

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

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : SitesManagementSettings-allOf[1]

型: object

ソースを表示

allowSiteCreation(optional): boolean

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

サイトの失効設定(サイトの失効時にサイトが自動的にオフラインにされ削除されるかどうかなど)。
リリース20.3.1で導入されました。
governanceEnabled(optional): boolean

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

サービス設定(サービスが有効かどうかなど)。
リリース20.1.2で導入されました。
siteAdminOnlyOperations(optional): siteAdminOnlyOperations

サイト、テンプレート、テーマおよびコンポーネントの作成をサイト管理者に制限します。
リリース20.1.2で導入されました。
siteSecurityPolicy(optional): siteSecurityPolicy

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

{
    "properties":{
        "allowSiteCreation":{
            "description":"<p>Allow your service users to create sites. When you enable the ability to create sites, you allow all users to create templates and sites. If you disable site creation, users can still see and work with templates and other folders in the hierarchy. Users can also still work with an existing site if the site is shared with them. They can view, edit, and manage the site, depending on their role. When you enable sites functionality, users have the ability to publish any content they have access to, including confidential information. You might want to limit your users to creating only secured sites, so that users have to sign in before they can see the site content. For even more security, you can limit site creation to administrators.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "governanceEnabled":{
            "description":"<p>Enable governance for sites to simplify and accelerate site delivery for business users, who are not site administrators, while giving site administrators an easy way to control and track sites from a centralized location.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "siteSecurityPolicy":{
            "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SecurityPolicy"
                }
            ]
        },
        "siteAdminOnlyOperations":{
            "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteAdminOnlyOperations"
                }
            ]
        },
        "prerender":{
            "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/PrerenderSettings"
                }
            ]
        },
        "expiration":{
            "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteExpirationSettings"
                }
            ]
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

ネストされたスキーマ: items

すべてに一致

ソースを表示

object 「リンク」

REST HATEOASリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

ネストされたスキーマ: Link

型: object

ソースを表示

href(optional): string

ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。
mediaType(optional): string

メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
method(optional): string
リンクのターゲットをリクエストするためのHTTPメソッド。
有効な値は次のとおりです。
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
profile(optional): string(uri)

ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
rel(optional): string

リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、falseとみなすことができます。

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

ネストされたスキーマ : 有効期限

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

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

すべてに一致

ソースを表示

object SiteExpirationSettings

サイト失効関連の設定(自動サイトの非アクティブ化および削除の有効化または無効化など)。サイトの有効期限は、サイト・ガバナンスが有効になっている場合にのみ有効です。
リリース20.3.1で導入されました。

{
    "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteExpirationSettings"
        }
    ]
}

ネストされたスキーマ : prerender

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

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

すべてに一致

ソースを表示

object PrerenderSettings

事前レンダリング・サービスの有効化または無効化、クローラおよびボット・ユーザー・エージェントの構成など、検索エンジンの最適化関連の設定。
リリース20.1.2で導入されました。

{
    "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/PrerenderSettings"
        }
    ]
}

ネストされたスキーマ : siteAdminOnlyOperations

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

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

すべてに一致

ソースを表示

object SiteAdminOnlyOperations

サイト管理者に制限される操作を定義します。
リリース20.1.2で導入されました。

{
    "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteAdminOnlyOperations"
        }
    ]
}

ネストされたスキーマ : siteSecurityPolicy

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

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

すべてに一致

ソースを表示

object SecurityPolicy

セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

{
    "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SecurityPolicy"
        }
    ]
}

ネストされたスキーマ : SiteExpirationSettings

型: object

サイト失効関連の設定(自動サイトの非アクティブ化および削除の有効化または無効化など)。サイトの有効期限は、サイト・ガバナンスが有効になっている場合にのみ有効です。

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

ソースを表示

action(optional): string
サイトの期限が切れたときに実行するアクション。これは何もできない可能性があります。サイトがオンラインの場合、サイトはオンラインのままになります。非アクティブ化アクションは、サイトの期限が切れた後にサイトをオフラインにします。サイトの期限が切れてサイトも削除されると、削除アクションはサイトをオフラインにします。サイトは、サイトが削除されるまでの失効後の期間を判断するために、翌日を使用して削除されます。
有効な値は次のとおりです。
- nothing - サイトはオンラインのままなので削除されません
- deactivate - サイトは、サイトの期限が切れるとオフラインになります
- delete - サイトは、有効期限が切れた後に構成可能な日数後にサイトの期限が切れるとオフラインになります
リリース20.3.1で導入されました。
deleteAfter(optional): integer(int32)

最小値: 3

最大値: 90

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

{
    "description":"<p>Site expiration related settings, such as enabling or disabling automatic site deactivation and deletion. Site expiration only takes affect if site governance is enabled.</p><small>Introduced in release 20.3.1.</small>",
    "properties":{
        "action":{
            "description":"<p>What action to take when the site expires. This can be do nothing. If the site is online the site will remain online. The deactivate action takes the site offline after the site expires. The delete action takes the site offline after the site expires and also deletes the site. The site is deleted using the days after to determine how long after expiration before the site is deleted.</p><p>Valid values are:\n<ul><li> <code>nothing</code> - Site is left online and is not deleted</li><li> <code>deactivate</code> - Site is taken offline when the site expires</li><li> <code>delete</code> - Site is taken offline when the site expires and deleted after a configurable number of days after expiration</li></p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "deleteAfter":{
            "description":"<p>Number of days to wait after a site expires before deleting the site. This setting is only used if the action selected is to delete expired sites. This setting can still be set if site deletion is disabled; the setting value will just be ignored. </p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32",
            "maximum":90,
            "minimum":3
        }
    }
}

ネストされたスキーマ : PrerenderSettings

型: object

事前レンダリング・サービスの有効化または無効化、クローラおよびボット・ユーザー・エージェントの構成など、検索エンジンの最適化関連の設定。

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

ソースを表示

enabled(optional): boolean

Prerenderサービスを有効または無効にします。
リリース20.1.2で導入されました。
userAgents(optional): string

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

{
    "description":"<p>Search engine optimization related settings, such as enabling or disabling the pre-render service and configuring crawler and bot user-agents.</p><small>Introduced in release 20.1.2.</small>",
    "properties":{
        "enabled":{
            "description":"<p>Enable or disable the Prerender Service.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "userAgents":{
            "description":"<p>Comma-separated list of user-agent product names that, if detected, will cause the client (crawlers and bots) to be redirected to the pre-render generated cached site content. Oracle Content Management has a built in list of crawlers and bots with is combined with this custom user-agent product names.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ : SiteAdminOnlyOperations

型: object

サイト管理者に制限される操作を定義します。

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

ソースを表示

componentCreation(optional): boolean

Trueの場合、サイト管理者のみがコンポーネントを作成できます。
リリース20.1.2で導入されました。
siteCreation(optional): boolean

Trueの場合、サイト管理者のみがサイトを作成できます。ガバナンスが有効な場合は無視されます。
リリース20.1.2で導入されました。
templateCreation(optional): boolean

Trueの場合、サイト管理者のみがテンプレートを作成できます。
リリース20.1.2で導入されました。
themeCreation(optional): boolean

Trueの場合、サイト管理者のみがテーマを作成できます。
リリース20.1.2で導入されました。

{
    "description":"<p>Defines the operations restricted to Site Administrators.</p><small>Introduced in release 20.1.2.</small>",
    "properties":{
        "siteCreation":{
            "description":"<p>If true, only site administrators can create sites. Ignored if governance is enabled.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "templateCreation":{
            "description":"<p>If true, only site administrators can create templates.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "themeCreation":{
            "description":"<p>If true, only site administrators can create themes.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "componentCreation":{
            "description":"<p>If true, only site administrators can create components.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : SecurityPolicy

型: object

セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

ソースを表示

appliesTo(optional): string
サイトにアクセス可能なユーザーのタイプを定義します。すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。
有効な値は次のとおりです。
- named - 指定されたレベル内の指定ユーザーのみがアクセスできます
- all - 指定されたレベル内のすべてのユーザーがアクセスできます
level(optional): string
サイトに設定できる最大オープン・セキュリティ・レベル。
有効な値は次のとおりです。
- service - サービス・ユーザーのみ
- cloud - ドメインにサインインできるクラウド・ユーザーのみ
- everyone - サインインせずに誰でも

{
    "description":"<p>The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.</p>",
    "properties":{
        "level":{
            "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "appliesTo":{
            "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

レスポンスの例 ()

{
    "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レスポンス

不正なリクエスト

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf InvalidSecurityScopeExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/InvalidSecurityScopeExceptionDetail"
        }
    ]
}

ネストされたスキーマ : InvalidSecurityScopeExceptionDetail

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。
object InvalidSecurityScopeExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "level":{
                    "description":"<p>Specified site security level.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "specifiedScope":{
                    "description":"<p>Specified site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "requiredScope":{
                    "description":"<p>Required site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : ExceptionDetail

型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
instance(optional): string(uri)

エラーに関する詳細を提供するリンクへのURI。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

エラーに対応するHTTPステータス・コード。
title(optional): string

問題の短く、判読可能なサマリー。タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。
type(optional): string(uri)

問題のタイプを識別する絶対URI。このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : InvalidSecurityScopeExceptionDetail-allOf[1]

型: object

ソースを表示

level(optional): string
指定されたサイト・セキュリティ・レベル。
有効な値は次のとおりです。
- service - サービス・ユーザーのみ
- cloud - ドメインにサインインできるクラウド・ユーザーのみ
- everyone - サインインせずに誰でも
requiredScope(optional): string
必須のサイト・セキュリティ・スコープです。
有効な値は次のとおりです。
- named - 指定されたレベル内の指定ユーザーのみがアクセスできます
- all - 指定されたレベル内のすべてのユーザーがアクセスできます
specifiedScope(optional): string
指定したサイト・セキュリティ範囲。
有効な値は次のとおりです。
- named - 指定されたレベル内の指定ユーザーのみがアクセスできます
- all - 指定されたレベル内のすべてのユーザーがアクセスできます

{
    "properties":{
        "level":{
            "description":"<p>Specified site security level.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "specifiedScope":{
            "description":"<p>Specified site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "requiredScope":{
            "description":"<p>Required site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示

Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

ネストされたスキーマ: items

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(無効なセキュリティ・スコープ)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Security Scope",
    "status":"400",
    "detail":"Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
    "o:errorCode":"OCE-SITEMGMT-009018",
    "level":"service",
    "specifiedScope":"named",
    "requiredScope":"all"
}

401レスポンス

未認可

403レスポンス

禁止

406レスポンス

受入れられない

409レスポンス

競合

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf StarterEditionGovernanceNotSupportedExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/StarterEditionGovernanceNotSupportedExceptionDetail"
        }
    ]
}

ネストされたスキーマ : StarterEditionGovernanceNotSupportedExceptionDetail

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

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

{
    "description":"<small>Introduced in release 21.6.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
        }
    ]
}

ネストされたスキーマ : ExceptionDetail

型: object

ソースを表示

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
instance(optional): string(uri)

エラーに関する詳細を提供するリンクへのURI。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

エラーに対応するHTTPステータス・コード。
title(optional): string

問題の短く、判読可能なサマリー。タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。
type(optional): string(uri)

問題のタイプを識別する絶対URI。このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示

Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

ネストされたスキーマ: items

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(Starter Edition Governanceはサポートされていません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Starter Edition Governance Not Supported",
    "status":"409",
    "detail":"Site governance is not supported in Starter Edition.",
    "o:errorCode":"OCE-SITEMGMT-009119"
}

413 レスポンス

ペイロードが大きすぎます

415 レスポンス

サポート対象外のメディア・タイプ

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト

先頭に戻る