機械翻訳について
  1. サイト管理用のREST API
  2. タスク
  3. サイト
  4. 作成、更新およびコピー

サイトの作成

post

/sites/management/api/v1/sites

COLLECTION

サイト名や説明などのサイト詳細を指定したサイト・テンプレートから新しいサイトを作成します。 サイト名は大/小文字が区別され、2つのサイトで同じ名前を共有することはできません。 サイト名に使用できるのは、文字、数字、ハイフンおよびアンダースコアのみです。 サイト・ガバナンスが有効になっている場合にサイト作成で承認が必要な場合は、サイト詳細を使用して理由を指定することもできます。

認可

サイト・ガバナンスが無効になっているサイトは、認証されたユーザーまたはクライアント・アプリケーション「メンバーです」のサイト・テンプレートから作成できます。 サイト・ガバナンスが有効になっているサイトがサイト・テンプレートから作成できるのは、サイト・テンプレートがactiveポリシーに関連付けられている場合です。 サイト・ガバナンスが有効になっている場合、サイトの作成リクエストを作成するには、サイトが作成される前に承認が必要な場合があります。 いずれの場合も、エンタープライズ・サイトを作成するには、ユーザーは「エンタープライズ・ユーザー」である必要があります。

エンタープライズ・サイト

テンプレートがエンタープライズ・テンプレートの場合、サイト・プレフィクス、ローカリゼーション・ポリシーまたはリポジトリなどのエンタープライズ・サイト関連のフィールドも、サイトの作成時に指定できます。 リポジトリが指定されている場合、認証されたユーザーまたはクライアント・アプリケーションには、リポジトリ内に少なくとも「コントリビュータ」ロールが必要です。

サイト・ガバナンスの抑制

サイト・ガバナンスが有効になっているサイトが、テンプレートがactiveポリシーに関連付けられている場合、テンプレートからのみ作成できます。 サイト管理者がポリシー制御をオーバーライドして任意のテンプレートからサイトを作成する必要がある場合、サイト・ガバナンス・ポリシーがヘッダー・パラメータを使用して抑制される可能性があります。 ヘッダーの詳細は、この操作の「リクエスト」の項を参照してください。

電子メール通知

サイト・ガバナンスが有効になっている場合、サイト作成のリクエストが原因で、サイト作成を承認できるユーザーに電子メール通知が送信されることがあります。 自動承認されたリクエストでは電子メール通知が送信されませんが、管理者または指定ユーザーの承認が必要なリクエストでは通知が送信されます。 承認者のプリファレンスによって「サイトの作成を承認することを他のユーザーがリクエストしたときに電子メールを送信」通知が許可されている場合、eメール通知が承認者に送信されます。 すべてのユーザーに対して通知が無効になっている場合は、電子メール通知は送信されません。 Eメール通知は、「通知の抑止」リクエスト・ヘッダーを用意することによって抑制できます。 このリクエスト・ヘッダーが存在すると、ユーザー・プリファレンスに関係なく、すべての電子メール通知が生成されなくなります。

自動承認

サイト・ガバナンスが有効になっている場合、特定の状況下では、承認が必要なサイトの作成リクエストを自動的に承認できます。 認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが、リクエストの承認を許可されているユーザーの1つである場合、リクエストを自動的に承認できます。 たとえば、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションにサイト管理者ロールがあり、サイトが管理者承認を必要とする場合、リクエストをすぐに承認できます。 自動承認を有効にするには、「自動承認リクエスト」リクエスト・ヘッダーを含めます。 このヘッダーを使用しない場合、サイトを作成するリクエストは、レビューが追加されるのを待機したまま「保留中」に残ります。 リクエストが自動的に承認された場合、電子メール通知は送信されません。

新規サイト・リクエストの進行状況の取得

サイト・ガバナンスが無効になっている場合、新規サイトの作成がただちに開始され、サイト・ジョブ・ステータス・リソースから進行状況をモニターできます。

詳細は、「サイト関連ジョブの進捗の取得」を参照してください。

サイト・ガバナンスが有効になっている新規サイト・リクエストの進行状況の取得

サイト・ガバナンスが有効になっている場合、新規サイトの作成に承認が必要であり、ステータス・リソースはリクエストが承認されるまでblockedジョブの進捗状況をレポートします。 リクエストが承認されると、サイト処理が開始され、ステータス・リソースを使用して進捗をモニターできます。 ステータスがsucceededに変わると、サイトは作成されています。 新規サイトのリクエストは、ステータス・リソースのrequestリンクを使用して識別できます。 リクエストに対するその後の操作(リクエストにレビューを追加して承認したり、サイト関係リソースを読み取ってサイト詳細を取得するなど)を実行できます。

詳細は、「リクエストの進行状況の確認」を参照してください。

非同期処理

この操作「のみ」非同期処理をサポートしています。 respond-asyncの値を持つPreferヘッダーがリクエストに含まれている必要があります。 「承認済」レスポンスにはLocationヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。

ステータスの読取りの詳細は、「サイト関連ジョブの進捗の取得」を参照してください。

成功したレスポンスの例

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

202Accepted - Create a Standard Site with Site Governance Off

標準サイトを作成するには、サイト名とテンプレートが必要です。 必要に応じて、摘要を指定できます。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch."
}

202確定済 - サイト・ガバナンスが有効なStandardサイトの作成

標準サイトを作成するには、サイト名とテンプレートが必要です。 必要に応じて、摘要を指定できます。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch.",
  "justification": "I require a marketing site for our new product."
}

202確定済 - Site Governance Offを使用してエンタープライズ・サイトを作成します。

エンタープライズ・サイトを作成する場合、サイト名、テンプレート、リポジトリ、ローカリゼーション・ポリシーおよびデフォルト言語が必要です。 必要に応じて、サイトのプレフィクスと説明を指定できます。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch.",
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "defaultLanguage": "en-US"
}

202確定済 - サイト・ガバナンスが有効なエンタープライズ・サイトの作成

エンタープライズ・サイトを作成する場合、サイト名、テンプレートおよびデフォルト言語が必要です。 ポリシーに応じて、リポジトリ、ローカリゼーション・ポリシーおよびサイト・プレフィクスを使用できます。 必要に応じて、摘要を指定できます。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch.",
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "localizationPolicy": "7D77CB6653BC1FF8E0530100007F6630",
  "defaultLanguage": "en-US",
  "sitePrefix": "News",
  "justification": "I require a marketing site for our new product."
}

202確定済 - サイト・ガバナンス管理の抑制

抑制ヘッダーを指定してサイト・ガバナンス・ポリシーを渡すことで、サイト管理者が任意のテンプレートのサイトを作成できます。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async
X-Suppress-Site-Governance=true

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch."
}
リリース19.4.1で導入されました。

202確定済 - サイトの作成およびEメール通知の抑制

通常は承認者に送信されるEメール通知を抑制するサイトを作成します。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

X-Suppress-Notifications=true
Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch."
}
リリース20.1.3で導入されました。

202確定済 - サイトの作成とリクエストの自動承認

認証されたユーザーまたはクライアント・アプリケーションでもリクエストを承認できる場合は、サイトを作成し、サイトを作成するリクエストを自動的に承認します。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

X-Auto-Approve-Request=true
Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch."
}
リリース20.1.3で導入されました。

202確定済 - 指定ユーザーのサイトの作成

別のユーザーのかわりにサイトを作成します。 サイトの作成時に指定されたユーザーが所有するように、サイトのリクエストを許可します。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch.",
  "ownedBy": "username:jsmith"
}
リリース20.3.3で導入されました。

202確定済 - 名前付きアプリケーションのサイトの作成

別のクライアント・アプリケーションのかわりにサイトを作成します。 サイトの作成時に指定されたクライアント・アプリケーションによって所有されるように、サイトのリクエストを許可します。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch.",
  "ownedBy": "application:MyProduct_APPID"
}
リリース20.3.3で導入されました。

202確定済 - SSTサイトの作成

きめ細かなセキュリティが必要なテンプレートを使用してサイトを作成します。 サイト・セキュリティ・タクソノミのIDとタクソノミ内のカテゴリのIDの両方を指定する必要があります。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "template": "name:Acme",
  "name": "AcmeProductLaunch",
  "description": "Marketing site for Acme New Product Launch.",
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "defaultLanguage": "en-US",
  "contentSecurity": {
    "taxonomy": "9CD715E67F21447D83F2708684E936EC",
    "category": "FFA550A5BCE34073A5BAB279B871DBFE"
  }
}

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

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

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

400Bad Request - Invalid Site Name

指定されたサイト名に使用できません。使用できる文字または語が含まれています。 サイト名が無効な理由がエラー・メッセージにレポートされます。

エラー・コード

OCE-SITEMGMT-009012

解決 - スペースの削除

サイト名を変更して、空白が含まれないようにしてください。

解決 - チェック文字

サイト名に使用できるのは、文字、数字、ハイフンおよびアンダースコアのみです。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
siteName無効なサイト名です。
reasonサイト名が無効な理由。 有効な値は次のとおりです。
  • tooLong - 名前が長すぎます。
  • invalidCharacters - 名前に無効な文字が含まれています
  • startWithSpace - 名前が空白で始まります
  • endWithSpace - 名前が空白で終わる
  • internalWord - 名前が制限付きの内部語である
  • empty - 名前が空です

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Name",
  "status": "400",
  "detail": "Site name '{siteName}' cannot be used to create a site.",
  "o:errorCode": "OCE-SITEMGMT-009012",
  "siteName": "MyNewProduct",
  "reason": "tooLong"
}

400Bad Request - Invalid Site Prefix

サイト・プレフィクスが有効なプレフィクスではありません。

エラー・コード

OCE-SITEMGMT-009034

解決 - スペースの削除

空白が含まれないようにサイト・プレフィクスを変更してください。

解決 - チェック文字

サイト・プレフィクスには、文字、数字、ハイフンおよびアンダースコアのみを使用してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
sitePrefix無効なサイト・プレフィクス値です。 サイト・プレフィクスの長さは15文字までです。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Prefix",
  "status": "400",
  "detail": "Site prefix '{sitePrefix}' contains invalid characters.",
  "o:errorCode": "OCE-SITEMGMT-009034",
  "sitePrefix": "News Site"
}

400Bad Request - Invalid Site Field

関連するサイト(コピー・リクエスト用)またはテンプレート(新規サイト・リクエスト用)でフィールドが必須でないか、またはサポートされていないため、リクエスト内のフィールドを指定できないことを示します。 たとえば、標準テンプレートを使用するサイトのリクエストでは、ローカリゼーション・ポリシーを指定できません。

エラー・コード

OCE-SITEMGMT-009017

解決 - デフォルト言語フィールドの削除

テンプレートまたはサイトが標準テンプレートまたは標準サイトの場合は、リクエストdefaultLanguageフィールドを削除します。

解決 - ローカリゼーション・ポリシーのフィールドの削除

テンプレートまたはサイトが標準テンプレートまたは標準サイトの場合は、リクエストlocalizationPolicyフィールドを削除します。

解決 - リポジトリ・フィールドの削除

テンプレートまたはサイトが標準テンプレートまたは標準サイトの場合は、リクエストrepositoryフィールドを削除します。

解決 - サイト・プレフィクス・フィールドの削除

テンプレートまたはサイトが標準テンプレートまたは標準サイトの場合は、リクエストsitePrefixフィールドを削除します。

解決 - デフォルト言語フィールドの削除

テンプレートまたはサイトが標準テンプレートまたは標準サイトの場合は、リクエストdefaultLanguageフィールドを削除します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
fieldNameサイトのタイプと互換性がないフィールド名。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Field",
  "status": "400",
  "detail": "Field '{fieldName}' should not be provided for this request.",
  "o:errorCode": "OCE-SITEMGMT-009017",
  "fieldName": "defaultLanguage"
}

400Bad Request - Invalid Site Owner

新しいサイトをリクエストし、目的の所有者を指定するには、ユーザーまたはクライアント・アプリケーションが存在し、標準ユーザー、エンタープライズ・ユーザー、サイト管理者ロールなどのCECロールを持っている必要があります。

エラー・コード

OCE-SITEMGMT-009021

解決 - ユーザーの存在確認

ユーザー識別子が有効であることを確認してください。

解決 - ロールのチェック

ユーザーまたはアプリケーションに、必要なロールのいずれかがあることを確認します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
user存在しないユーザーまたはアプリケーション。
requiredRolesユーザーには、これらのアプリケーション・ロールの少なくとも1つが所有者である必要があります。 有効な値は次のとおりです。
  • CECServiceAdministrator - サービス管理者
  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者
  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者
  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー
将来使用するために予約済
  • CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
  • CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Owner",
  "status": "400",
  "detail": "User or application does not exist, or does exist but does not have an appropriate role.",
  "o:errorCode": "OCE-SITEMGMT-009021",
  "user": {
    "id": "1234"
  },
  "requiredRoles": [
      "CECServiceAdministrator"
  ]
}

400Bad Request - Invalid Site Template

リクエストで参照されているテンプレート、またはリソースに関連付けられているテンプレートが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションがテンプレートへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009010

解決 - 識別子のチェック

テンプレート識別子が有効であることを確認してください。

解決 - 認可の確認

認証されたユーザーがテンプレートへのアクセスを認可されていることを確認します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
template存在しないか、認証されたユーザーに表示されないテンプレート。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Template",
  "status": "400",
  "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
  "o:errorCode": "OCE-SITEMGMT-009010",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

400Bad Request - Invalid Repository

参照されているリポジトリが見つかりませんでした。 リポジトリが存在しないか、削除されたか、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションがリポジトリへのアクセス権を持っていません。

エラー・コード

OCE-CAAS-001006

解決 - 識別子のチェック

リポジトリ識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証されたユーザーがリポジトリのメンバーであること、およびリポジトリに関連する操作を実行するための関連ロールを持っていることを確認してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
repositoryリポジトリ識別子が指定されている場合、存在しない、または認証ユーザーに対して表示されないリポジトリ。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Repository",
  "status": "400",
  "detail": "Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
  "o:errorCode": "OCE-CAAS-001006",
  "repository": {
    "id": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
  }
}

リリース19.2.3.での導入。

400Bad Request - Invalid Localization Policy

参照されているローカリゼーション・ポリシーが見つかりませんでした。 ローカリゼーション・ポリシーが存在しないか、削除されているか、または指定した識別子が正しくありません。

エラー・コード

OCE-CAAS-001004

解決 - 識別子のチェック

ローカリゼーション・ポリシー識別子が有効であることを確認してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
localizationPolicy存在しないローカリゼーション・ポリシー。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Localization Policy",
  "status": "400",
  "detail": "Localization policy does not exist.",
  "o:errorCode": "OCE-CAAS-001004",
  "localizationPolicy": {
    "id": "7D77CB6653BC1FF8E0530100007F6630"
  }
}

リリース19.2.3.での導入。

400Bad Request - Invalid Default Language

デフォルト言語が欠落しているか、関連付けられたローカリゼーション・ポリシーでサポートされている必須言語のいずれかではありません。

エラー・コード

OCE-CAAS-001003

解決 - デフォルト言語がありません

デフォルト言語が指定されていない場合は、エラー・メッセージに示されているデフォルト言語が指定されていることを確認してください。

解決 - 言語がサポートされていません

デフォルト言語が指定されている場合は、提供された言語がエラー・メッセージに示されている言語のいずれかと一致していることを確認してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
localizationPolicy指定したデフォルト言語が許可されないローカリゼーション・ポリシー。
defaultLanguageデフォルト言語が無効です。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Default Language",
  "status": "400",
  "detail": "Default Language '{defaultLanguage}' is not valid. The default language must be one of the localization policy's required languages.",
  "o:errorCode": "OCE-CAAS-001003",
  "defaultLanguage": "en-US"
}

リリース19.2.3.での導入。

400Bad Request - Inactive Template Policy

テンプレートには、アクティブとしてマークされているポリシーがありません。 このエラーは、サイト管理者がサイト作成元に適したテンプレートにマークを付けていないため、このテンプレートからサイトを作成できないことを示します。 このエラーは、サイト・ガバナンスが有効になっている場合にのみ発生する可能性があります。

エラー・コード

OCE-SITEMGMT-009015

解決 - ポリシーがアクティブであることの確認

サイト管理者に問い合せて、テンプレートに関連付けられているポリシーがあり、アクティブとしてマークされていることを確認してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
templateポリシーがないか、ポリシーが非アクティブであるテンプレート。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Inactive Template Policy",
  "status": "400",
  "detail": "There is no active policy associated with the template.",
  "o:errorCode": "OCE-SITEMGMT-009015",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

400Bad Request - Restricted Template Policy

このエラーは、リクエスタが含まれない制限付きオーディエンスに対するサイト作成をサイト管理者が制限しているため、リクエスタがこのテンプレートを使用してサイトを作成できないことを示します。 このエラーは、サイト・ガバナンスが有効になっている場合にのみ発生します。

エラー・コード

OCE-SITEMGMT-009033

解決 - アクセス・リストへのユーザーの追加

サイト管理者を取得して、ユーザーをポリシー・アクセス・リストのメンバーとして追加します。

解決 - ポリシーを全員のアクセスに変更

サイト管理者を取得して、テンプレート・ポリシーaccessTypeをeveryoneに変更します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
template制限付きポリシーがあるテンプレート。
userテンプレート・ポリシー・アクセス・リストのメンバーではないユーザーまたはアプリケーション。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Restricted Template Policy",
  "status": "400",
  "detail": "The policy associated with template has a restricted audience and can't be used by the user that created the request.",
  "o:errorCode": "OCE-SITEMGMT-009033",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  },
  "user": {
    "id": "1234"
  }
}

リリース19.3.2.での導入。

400Bad Request - Site Request Timeout

リクエストが承認されると、リクエストは適度な時間内に処理される必要があります。 リクエストが承認されたがまだ完了していない場合、処理が失われたりスタックする可能性があります。 この場合、リクエストには、リクエストに関連するタイムアウト・エラーが発生します。

エラー・コード

OCE-SITEMGMT-009014

解決 - リクエストの再試行

リクエストを再試行して、リクエスト処理を再開してください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
request処理がタイムアウトしたリクエストです。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Request Timeout",
  "status": "400",
  "detail": "Request processing has timed out.",
  "o:errorCode": "OCE-SITEMGMT-009014",
  "request": {
    "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7"
  }
}

400Bad Request - Unable to Import Site Content

サイト・コンテンツをインポートできないため、サイトを作成できません。 詳細フィールドに、コンテンツのインポートに失敗した理由が含まれています。

エラー・コード

OCE-SITEMGMT-009111

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
reasonエラー文字列。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Unable to Import Site Content",
  "status": "400",
  "detail": "{reason}",
  "o:errorCode": "OCE-SITEMGMT-009111"
}

400不正なリクエスト - サイトIDはサポートされていません

サイトIDはサポートされていません。

エラー・コード

OCE-SITEMGMT-009134

解決 - ガバナンスの抑制

明示的なサイトIDを使用してサイトを作成するときにサイト・ガバナンスを抑制します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Id Not Supported",
  "status": "400",
  "detail": "Site id is not supported when creating site requests with site governance enabled.",
  "o:errorCode": "OCE-SITEMGMT-009134"
}

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

400不正なリクエスト - 無効なサイトID

指定されたサイトIDの長さ、プリフィクスまたは文字が無効であるため、使用できません。 サイト名が無効な理由がエラー・メッセージにレポートされます。

エラー・コード

OCE-SITEMGMT-009135

解決 - チェックの長さ

IDは44文字の長さにする必要があります。

解決 - 小切手プリフィクス

IDはFという文字で始まる必要があります。

解決 - チェック文字

文字と数字のみを使用してください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
reasonサイト名が無効な理由。 有効な値は次のとおりです。
  • invalidCharacters - GUIDに無効な文字が含まれています
  • invalidLength - GUIDの長さが無効です
  • invalidPrefix - GUIDプレフィクスが無効です

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Id",
  "status": "400",
  "detail": "Site id cannot be used to create site.",
  "o:errorCode": "OCE-SITEMGMT-009135",
  "reason": "invalidCharacters"
}

400不正なリクエスト - 無効なサイト・コンテンツ・セキュリティ

詳細なセキュリティを適用するテンプレートから新しいSSTサイトをリクエストする場合は、サイト・セキュリティ・タクソノミおよびカテゴリを指定する必要があります。 ユーザーまたはクライアント・アプリケーションには、カテゴリに対するサイトの作成権限も必要です。

エラー・コード

OCE-SITEMGMT-009146

解決 - コンテンツ・セキュリティの提供

コンテンツ・セキュリティを提供する必要があります。

解決 - コンテンツ・セキュリティの存在のチェック

タクソノミおよびカテゴリが存在することを確認します。

解決 - サイト管理のコンテンツ・セキュリティの確認

指定されたタクソノミがサイト管理用であることを確認してください。

解決 - サイトの作成権限の確認

ユーザーまたはクライアント・アプリケーションに、カテゴリに対するサイト作成権限があることを確認してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
securityコンテンツ・セキュリティが存在しないか、適切な権限がありません。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Content Security",
  "status": "400",
  "detail": "Content security must be provided. The taxonomy and category must exist, with the user or client application having the create site permission on the category.",
  "o:errorCode": "OCE-SITEMGMT-009146",
  "security": {
    "taxonomy": {
      "id": "BC42C4FE109446539C9962DAC0C64CF2"
    },
    "category": {
      "id": "AF11C4FE109446539C9962DAC0C09KF2"
    }
  }
}

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

400不正なリクエスト - ローカリゼーション・ポリシーが必要です

サイト・リクエストを完了するには、ローカリゼーション・ポリシーが必要です。 これは、テンプレート・ポリシーの一部であるか、リクエストに含まれている必要があります。

エラー・コード

OCE-CAAS-001022

解決 - ローカリゼーション・ポリシーを含める

ローカリゼーション・ポリシーがテンプレート・ポリシーまたはリクエストの一部として指定されていることを確認します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Localization Policy Required",
  "status": "400",
  "detail": "Localization policy required.",
  "o:errorCode": "OCE-CAAS-001022"
}

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

403Forbidden - Asset Limit Reached

アセット限度に達しました。 アセット制限は、作成可能なアセット額に対してシステム管理者が設定しています。

エラー・コード

OCE-SITEMGMT-009097

解決 - アセット限度の増加

アセット制限を増やすためにシステム管理者に連絡します。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
used資産数
limitアセット限度。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Asset Limit Reached",
  "status": "403",
  "detail": "Asset limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009097",
  "used": 1234567890,
  "limit": 1234567890
}

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

403Forbidden - Advanced Video Limit Reached

高度なビデオ制限に達しました。 高度なビデオ制限は、システム管理者が作成できる高度なビデオの量に対して設定されています。

エラー・コード

OCE-SITEMGMT-009099

解決 - 高度なビデオ制限の拡大

システム管理者は、詳細なビデオ制限を増やすことができます。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
used高度なビデオの数。
limit高度なビデオ制限。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Advanced Video Limit Reached",
  "status": "403",
  "detail": "Advanced video limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009099",
  "used": 1234567890,
  "limit": 1234567890
}

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

403Forbidden - Storage Limit Reached

ストレージ転送制限に達しました。 請求限度は、システム管理者が使用可能なストレージ容量に設定されています。

エラー・コード

OCE-SITEMGMT-009098

解決 - ストレージ制限の増加

ストレージ制限を増やすシステム管理者を取得します。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
used使用済ストレージ(GB)。
limitストレージ制限(GB)。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Storage Limit Reached",
  "status": "403",
  "detail": "Storage limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009098",
  "used": 1.23456789,
  "limit": 1.23456789
}

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

403禁止 - サイト管理者ロール必須

このタイプのリソースを作成するには、サイト管理者ロールが必要です。

エラー・コード

OCE-SITEMGMT-009140

解決 - サイト・システム設定の変更

サイト、テンプレート、テーマおよびコンポーネントの作成は、サイト管理者に制限できます。 管理者以外のユーザーがこのタイプのサイト・リソースを作成できるように、サイト・システム設定を更新します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
resourceTypeサイト管理者のみが作成できるリソース・タイプ。 有効な値は次のとおりです。
  • site - サイト・リソース
  • template - テンプレート・リソース
  • theme - テーマ・リソース
  • component - コンポーネント・リソース
name作成中のリソースの名前(使用可能な場合)。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Sites Administrator Role Required",
  "status": "403",
  "detail": "The Sites Administrator role is required to create resources of this type.",
  "o:errorCode": "OCE-SITEMGMT-009140",
  "resourceType": "site",
  "name": "value"
}

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

409Conflict - Site Already Exists

同じ名前のサイトがすでに存在します。 サイト名はすべてのサイトで一意である必要があります。

エラー・コード

OCE-SITEMGMT-009004

解決 - サイト名の編集

既存のサイトと競合しないように、リクエストのサイト名を編集します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
name重複している名前です

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Already Exists",
  "status": "409",
  "detail": "A site with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009004",
  "name": "Oracle Content and Experience"
}

409Conflict - Site Prefix Already Exists

同じサイト・プレフィクスを持つサイトがすでに存在します。 サイト・プレフィクスはすべてのサイトで一意である必要があります。

エラー・コード

OCE-SITEMGMT-009029

解決 - サイト・プレフィクスの編集

既存のサイトと競合しないように、リクエストのサイト・プレフィクスを編集します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
sitePrefix既存のサイトと競合しているサイト・プレフィクス値。 サイト・プレフィクスの長さは15文字までです。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Prefix Already Exists",
  "status": "409",
  "detail": "Site with prefix '{sitePrefix}' already exists.",
  "o:errorCode": "OCE-SITEMGMT-009029",
  "sitePrefix": "News"
}

リリース19.2.3.での導入。

409Conflict - Site Policy Violation

テンプレートまたはサイト・ポリシーでは、フィールド値が存在しないことまたはフィールド値(存在するもの)の使用を禁止することが必要です。 エラー・メッセージではフィールド名と、そのフィールドが禁止されているか必須かが指定されます。 このエラーは、サイト・ガバナンスが有効になっている場合にのみ発生する可能性があります。

エラー・コード

OCE-SITEMGMT-009035

解決 - ローカリゼーション・ポリシーが許可されていることの確認

ローカリゼーション・ポリシーを指定する場合、そのポリシーで、リクエストにローカリゼーション・ポリシーを指定できることを確認します。

解決 - サイト・プレフィクスのチェックが許可されます

サイト・プレフィクスを指定する場合は、リクエストでサイト・プレフィクスの指定がポリシーで許可されていることを確認してください。

解決 - リポジトリを指定しない

リポジトリを指定する場合は、ポリシーですでにリポジトリが指定されていないことを確認します。

解決 - リポジトリの指定

ポリシーでリポジトリが指定されていない場合、リクエストではリポジトリを指定する必要があります。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
fieldNameフィールドの名前。
constraintフィールドが必須であるか、禁止されていることを示します。 有効な値は次のとおりです。
  • required - フィールドは必須です
  • prohibited - フィールドは許可されていません

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Policy Violation",
  "status": "409",
  "detail": "Field '{fieldName}' is {constraint} by the policy associated with this request.",
  "o:errorCode": "OCE-SITEMGMT-009035",
  "fieldName": "repository",
  "constraint": "required"
}

リリース19.2.3.での導入。

409Conflict - Site Governance Disabled

サイト・ガバナンスが有効または無効になるのは、サイト管理者が制御するテナント全体の設定です。 サイト・ガバナンスが無効になっている場合、サイトに対するリクエストの作成、サイトのアクティブ化など、サイト管理REST APIで特定のメソッドが禁止されます。

エラー・コード

OCE-SITEMGMT-009002

解決 - サイト・ガバナンスの有効化

「サイトとアセット」管理者設定を使用してサイトのガバナンスを有効にし、失敗したリクエストを再試行してください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Governance Disabled",
  "status": "409",
  "detail": "A request to create or copy a site cannot be processed when site governance is disabled.",
  "o:errorCode": "OCE-SITEMGMT-009002"
}

409Conflict - Template Deleted

ソフト削除テンプレートでは操作を実行できません。 このエラーは、includeDeleted問合せパラメータがtrueに設定されている場合にのみ発生

エラー・コード

OCE-SITEMGMT-009061

解決 - テンプレートのリストア

テンプレートをリストアしてから操作を再試行してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
templateソフト削除されるテンプレート。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Deleted",
  "status": "409",
  "detail": "The operation cannot be performed as the template has been soft deleted.",
  "o:errorCode": "OCE-SITEMGMT-009061",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

リリース19.4.1.での導入。

409Conflict - Template Import In Progress

このエラーは、テンプレートのコピー(サイトの作成など)が行われるが、テンプレートのインポートによって上書きされる場合に発生します。

エラー・コード

OCE-SITEMGMT-009105

解決 - テンプレートのインポートが完了するまで待機

テンプレートのインポートが完了するまで待機し、再試行してください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
importedBy進行中のインポート・ジョブを作成したユーザーのフルネーム。
nameテンプレート名

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Import In Progress",
  "status": "409",
  "detail": "Unable to copy template as it is in the progress of being re-imported.",
  "o:errorCode": "OCE-SITEMGMT-009105",
  "importedBy": "value",
  "name": "CafeSupremo"
}

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

409競合 - Starter Edition制限に達しました

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

エラー・コード

OCE-SITEMGMT-009117

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

無制限のサイトにアクセスするには、Premiumにアップグレードしてください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Starter Edition Limit Reached",
  "status": "409",
  "detail": "Starter edition will only allow you to create one site.",
  "o:errorCode": "OCE-SITEMGMT-009117"
}

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

409競合 - 重複サイトID

指定されたIDのサイトはすでに存在します。

エラー・コード

OCE-SITEMGMT-009136

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
idサイトIDが重複しています。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Duplicate Site Id",
  "status": "409",
  "detail": "A site with the provided id already exists.",
  "o:errorCode": "OCE-SITEMGMT-009136",
  "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}

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

409競合 - サイト・コンテンツ・セキュリティはサポートされていません

新しいSSTサイトをリクエストする場合、コンテンツ・セキュリティを提供する場合は、テンプレートで詳細なセキュリティを有効にする必要があります。

エラー・コード

OCE-SITEMGMT-009147

解決 - 詳細なセキュリティ・テンプレートの提供

きめ細かなセキュリティで有効化されたテンプレートを提供します。

解決 - コンテンツ・セキュリティの削除

作成時にコンテンツ・セキュリティを提供しないでください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Content Security Not Supported",
  "status": "409",
  "detail": "Content security not supported for site creation.",
  "o:errorCode": "OCE-SITEMGMT-009147"
}

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

409競合 - サイト・コレクションはすでに存在

同じ名前のコレクションがすでに存在します。 サイト・コレクション名はすべてのコレクションで一意である必要があります。

エラー・コード

OCE-SITEMGMT-009154

解決 - サイト名の編集

既存のコレクションと衝突しないように、リクエストのサイト名を編集します。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
nameコレクション名が重複しています。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Collection Already Exists",
  "status": "409",
  "detail": "A collection with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009154",
  "name": "Oracle Content and Experience"
}

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

409競合 - サイト・チャネルはすでに存在

同じ名前のチャネルがすでに存在します。 チャネル名はすべてのサイトで一意である必要があります。

エラー・コード

OCE-SITEMGMT-009155

解決 - サイト名の編集

既存のチャネルと衝突しないように、リクエストのサイト名を編集します。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
channelNameチャネル名

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Channel Already Exists",
  "status": "409",
  "detail": "A channel with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009155",
  "channelName": "Oracle Content and Experience"
}

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

409競合 - サイト・コンテンツ・セキュリティ・グループはすでに存在

指定された名前のSSTグループがすでに存在するため、サイト操作を実行できません。 グループ名は親サイト名に基づきます。

エラー・コード

OCE-SITEMGMT-009158

解決 - サイト名の編集

既存のコンテンツ・セキュリティ・グループと衝突しないように、リクエストのサイト名を編集します。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
groupName既存のグループ名。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Content Security Group Already Exists",
  "status": "409",
  "detail": "Site rename cannot be performed as there is an existing content security group with the same name.",
  "o:errorCode": "OCE-SITEMGMT-009158",
  "groupName": "Oracle Content and Experience"
}

409競合 - ブロックされたファイル拡張子

ブロックされた拡張子のファイルが含まれているため、サイト操作を実行できません。

エラー・コード

OCE-SITEMGMT-009163

解決 - ブロックされたファイルを削除

ブロックされたファイル拡張子を使用するファイルをサイトから削除

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
fileExtensionブロックされたファイル拡張子

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Blocked File Extension",
  "status": "409",
  "detail": "Unable to perform site operation as it contains a file with a blocked extension",
  "o:errorCode": "OCE-SITEMGMT-009163",
  "fileExtension": "value"
}

リクエスト

サポートされているメディア・タイプ
ヘッダー・パラメータ

  • respond-asyncヘッダー値を使用してリクエストの非同期処理をリクエストします。

  • サイト・ガバナンスが有効なときにサイトを作成またはコピーするリクエストが行われると、そのリクエストは自動承認されます。 認証されたユーザーがリクエストの承認を許可されているユーザーのいずれかである場合、リクエストは自動的に承認されます。 たとえば、認証されたユーザーがサイト管理者ロールを持ち、サイトが管理者の承認を必要とする場合、リクエストを自動的に承認できます。 ユーザーがリクエストを承認できない場合、ヘッダーが含まれます。 自動承認を有効にするには、有効な場合、このヘッダーを値trueでリクエストに追加します。

  • リクエストごとに通知が送信されないようにするクライアントの場合、このヘッダーは値trueに設定できます。 通知が通常送信される場合でも、このヘッダーによってリクエストの通知配信が抑制されます。

  • サイト管理者がサイト関連の操作でポリシーを渡すと、サイトのガバナンス抑制ヘッダーをリクエストの値trueに設定できます。 ポリシーがinactiveの場合でも、このヘッダーが設定されている場合は、サイト管理者が操作を実行できます。 承認のタイプや、サイト・プレフィクスの指定などの操作の制限などのその他のポリシー管理も抑制されます。

本文()

必要なサイトの詳細。

ルート・スキーマ: schema
型: object
ソースを表示
  • contentSecurity

    サイトのセキュリティ・カテゴリ。

    将来のリリースを対象としています。

    この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

  • サイトのデフォルト言語。 ローカリゼーション・ポリシーの必須言語の1つである必要があります。 エンタープライズ・サイトに対するリクエストで必要です。

    リリース19.2.3.での導入。
  • 最大長: 1000

    サイトの説明は、サイトの目的や使用状況をユーザーが理解するのに役立ちます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

  • オプションでサイトの識別子を指定しました。 このIDはサービス内で一意である必要があります。 指定しない場合、識別子は自動的に割り当てられます。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

  • 最大長: 1000

    理由は、承認者がこのリクエストをレビューするのに役立ちます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

  • links

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

  • サイトの作成時にサイトに関連付けられるローカリゼーション・ポリシーです。 ローカリゼーション・ポリシーは、エンタープライズ・サイトに対してのみ設定できます。 リクエストに関連付けられているポリシーがローカリゼーション・ポリシーを指定している場合、ローカリゼーション・ポリシーはリクエストに関連付けられません。

    リリース19.2.3.での導入。
  • 最大長: 242

    この名前はサイト作成プロセスで使用され、新しいサイトの識別に使用されます。 名前は一意である必要があります。指定した名前は既存のサイトの名前と同じにできません。

  • サイトを所有するユーザーまたはクライアント・アプリケーションを取得します。 サイトを所有するユーザーまたはクライアント・アプリケーションは、別のユーザーのかわりにリクエストが作成された場合にリクエストを作成したユーザーまたはクライアント・アプリケーションとは異なる場合があります。

  • サイトの作成時にサイトに関連付けられるアセット・リポジトリ。 リポジトリは、エンタープライズ・サイトに対してのみ設定できます。 リクエストに関連付けられているポリシーでリポジトリが指定されている場合、リポジトリをリクエストに関連付けることはできません。

    リリース19.2.3.での導入。
  • 最大長: 15

    サイトの作成時にサイトに設定されるサイト・プレフィクス。 エンタープライズ・サイトのリクエストにのみ設定されます。 リクエストに関連付けられているポリシーで許可されている場合のみ設定できます。そうでない場合、サイト・プレフィクスが自動的に生成されます。 サイト・プレフィクスの長さは15文字までです。

    リリース19.2.3.での導入。

  • リクエストに関連付けられているテンプレートを取得します。 新規サイトのリクエストが作成されると、サイトを作成するテンプレートが指定され、リクエストに関連付けられます。 リクエストが新規サイト・リクエストでない場合、テンプレートは返されません。

例:
{
    "template":"name:Acme",
    "name":"AcmeProductLaunch",
    "description":"Marketing site for Acme New Product Launch."
}
ネストされたスキーマ : contentSecurity

サイトのセキュリティ・カテゴリ。

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

すべてに一致
ソースを表示
  • SiteContentSecurity

    サイトのコンテンツ・セキュリティ。

    将来のリリースを対象としています。

    この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

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

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

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

サイトのコンテンツ・セキュリティ。

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

ソースを表示

  • 関連付けられたタクソノミ・カテゴリ・リソース。

    将来のリリースを対象としています。

    この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

  • 関連付けられたタクソノミ・リソース。

    将来のリリースを対象としています。

    この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 「リンク」
トップに戻る

レスポンス

202レスポンス

Accepted
ヘッダー

400レスポンス

不正なリクエスト
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : InvalidSiteNameExceptionDetail
すべてに一致
ソースを表示
  • ExceptionDetail

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

  • InvalidSiteNameExceptionDetail-allOf[1]
ネストされたスキーマ : ExceptionDetail
型: object

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

ソースを表示

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

  • エラーに関する詳細を提供するリンクへのURI。

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

  • o:errorDetails

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

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

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

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

ネストされたスキーマ : InvalidSiteNameExceptionDetail-allOf[1]
型: object
ソースを表示

  • サイト名が無効な理由。

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

    • tooLong - 名前が長すぎます。
    • invalidCharacters - 名前に無効な文字が含まれています
    • startWithSpace - 名前が空白で始まります
    • endWithSpace - 名前が空白で終わる
    • internalWord - 名前が制限付きの内部語である
    • empty - 名前が空です

  • 最大長: 242

    無効なサイト名です。

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

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

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

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

レスポンスの例(無効なサイト名)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Name",
    "status":"400",
    "detail":"Site name '{siteName}' cannot be used to create a site.",
    "o:errorCode":"OCE-SITEMGMT-009012",
    "siteName":"MyNewProduct",
    "reason":"tooLong"
}
レスポンスの例(無効なサイト・プレフィクス)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Prefix",
    "status":"400",
    "detail":"Site prefix '{sitePrefix}' contains invalid characters.",
    "o:errorCode":"OCE-SITEMGMT-009034",
    "sitePrefix":"News Site"
}
レスポンスの例(無効なサイト・フィールド)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Field",
    "status":"400",
    "detail":"Field '{fieldName}' should not be provided for this request.",
    "o:errorCode":"OCE-SITEMGMT-009017",
    "fieldName":"defaultLanguage"
}
レスポンスの例(無効なサイト所有者)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Owner",
    "status":"400",
    "detail":"User or application does not exist, or does exist but does not have an appropriate role.",
    "o:errorCode":"OCE-SITEMGMT-009021",
    "user":{
        "id":"1234"
    },
    "requiredRoles":[
        "CECServiceAdministrator"
    ]
}
レスポンスの例(無効なサイト・テンプレート)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Template",
    "status":"400",
    "detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
    "o:errorCode":"OCE-SITEMGMT-009010",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}
レスポンスの例(無効なリポジトリ)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Repository",
    "status":"400",
    "detail":"Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
    "o:errorCode":"OCE-CAAS-001006",
    "repository":{
        "id":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
    }
}
レスポンスの例(無効なローカリゼーション・ポリシー)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Localization Policy",
    "status":"400",
    "detail":"Localization policy does not exist.",
    "o:errorCode":"OCE-CAAS-001004",
    "localizationPolicy":{
        "id":"7D77CB6653BC1FF8E0530100007F6630"
    }
}
レスポンスの例 (無効なデフォルト言語)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Default Language",
    "status":"400",
    "detail":"Default Language '{defaultLanguage}' is not valid. The default language must be one of the localization policy's required languages.",
    "o:errorCode":"OCE-CAAS-001003",
    "defaultLanguage":"en-US"
}
レスポンスの例(非アクティブなテンプレート・ポリシー)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Inactive Template Policy",
    "status":"400",
    "detail":"There is no active policy associated with the template.",
    "o:errorCode":"OCE-SITEMGMT-009015",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}
レスポンスの例(制限付きテンプレート・ポリシー)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Restricted Template Policy",
    "status":"400",
    "detail":"The policy associated with template has a restricted audience and can't be used by the user that created the request.",
    "o:errorCode":"OCE-SITEMGMT-009033",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    },
    "user":{
        "id":"1234"
    }
}
レスポンスの例(サイトIDはサポートされていません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Id Not Supported",
    "status":"400",
    "detail":"Site id is not supported when creating site requests with site governance enabled.",
    "o:errorCode":"OCE-SITEMGMT-009134"
}
レスポンスの例(無効なサイト・コンテンツ・セキュリティ)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Content Security",
    "status":"400",
    "detail":"Content security must be provided. The taxonomy and category must exist, with the user or client application having the create site permission on the category.",
    "o:errorCode":"OCE-SITEMGMT-009146",
    "security":{
        "taxonomy":{
            "id":"BC42C4FE109446539C9962DAC0C64CF2"
        },
        "category":{
            "id":"AF11C4FE109446539C9962DAC0C09KF2"
        }
    }
}
レスポンスの例(ローカリゼーション・ポリシーが必要)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Localization Policy Required",
    "status":"400",
    "detail":"Localization policy required.",
    "o:errorCode":"OCE-CAAS-001022"
}

401レスポンス

未認可

403レスポンス

禁止
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : SitesAdminRoleRequiredExceptionDetail
リリース22.5.2で導入されました。
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

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

ソースを表示

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

  • エラーに関する詳細を提供するリンクへのURI。

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

  • o:errorDetails

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

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

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

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

ネストされたスキーマ : SitesAdminRoleRequiredExceptionDetail-allOf[1]
型: object
ソースを表示

  • 作成中のリソースの名前(使用可能な場合)。

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

  • サイト管理者のみが作成できるリソース・タイプ。

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

    • site - サイト・リソース
    • template - テンプレート・リソース
    • theme - テーマ・リソース
    • component - コンポーネント・リソース

    リリース22.5.2で導入されました。
ネストされたスキーマ: o:errorDetails
型: array

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

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

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

レスポンスの例(Sites Administrator Role Required)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Sites Administrator Role Required",
    "status":"403",
    "detail":"The Sites Administrator role is required to create resources of this type.",
    "o:errorCode":"OCE-SITEMGMT-009140",
    "resourceType":"site",
    "name":"value"
}

409レスポンス

競合
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : SiteAlreadyExistsExceptionDetail
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

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

ソースを表示

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

  • エラーに関する詳細を提供するリンクへのURI。

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

  • o:errorDetails

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

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

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

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

ネストされたスキーマ : SiteAlreadyExistsExceptionDetail-allOf[1]
型: object
ソースを表示
ネストされたスキーマ: o:errorDetails
型: array

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

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

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

レスポンスの例(サイトはすでに存在します)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Already Exists",
    "status":"409",
    "detail":"A site with the same name already exists.",
    "o:errorCode":"OCE-SITEMGMT-009004",
    "name":"Oracle Content and Experience"
}
レスポンスの例(サイト・プレフィクスはすでに存在します)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Prefix Already Exists",
    "status":"409",
    "detail":"Site with prefix '{sitePrefix}' already exists.",
    "o:errorCode":"OCE-SITEMGMT-009029",
    "sitePrefix":"News"
}
レスポンスの例(サイト・ポリシー違反)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Policy Violation",
    "status":"409",
    "detail":"Field '{fieldName}' is {constraint} by the policy associated with this request.",
    "o:errorCode":"OCE-SITEMGMT-009035",
    "fieldName":"repository",
    "constraint":"required"
}
レスポンスの例(テンプレートの削除)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the template has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009061",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}
レスポンスの例(Starter Edition制限に達しました)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Starter Edition Limit Reached",
    "status":"409",
    "detail":"Starter edition will only allow you to create one site.",
    "o:errorCode":"OCE-SITEMGMT-009117"
}
レスポンスの例(サイト・コンテンツ・セキュリティはサポートされていません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Content Security Not Supported",
    "status":"409",
    "detail":"Content security not supported for site creation.",
    "o:errorCode":"OCE-SITEMGMT-009147"
}

413 レスポンス

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

415 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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