サイトのコピー
/sites/management/api/v1/sites/{id}/copy
サイトの摘要など、新しいサイト名とオプションの詳細を指定して、サイトをコピーします。 サイト名は大文字小文字を区別し、2つのサイトは同じ名前を共有できません。 サイト名に使用できるのは、文字、数字、ハイフンおよびアンダースコアのみです。 コピーされるサイトがエンタープライズ・サイトである場合、サイト・プレフィクスやリポジトリなどのエンタープライズ・サイト関連のフィールドも指定できます。 エンタープライズ・サイトでは、デフォルト言語とローカリゼーション・ポリシーは、コピーされるサイトと同じになります。 エンタープライズ・サイトがコピーされ、リポジトリが指定されている場合、認証されたユーザーまたはクライアント・アプリケーションは、リポジトリに少なくとも「コントリビュータ」ロールが必要です。 明示的な所有者が指定されていない場合、サイトの所有者は認証されたユーザーまたはクライアント・アプリケーションになります。 サイト・ガバナンスが有効になっている場合、サイトがコピーされる前にサイト・コピーで承認が必要になる可能性があるため、サイトの詳細についての理由も提供できます。
リリース19.1.5.での導入。
認可
サイト・ガバナンスが有効な場合、サイトのコピー・ポリシーによっては、サイトのコピーに承認が必要になることがあります。 ユーザーは、共有されており、次のいずれかの「共有」ロールを持つサイトをコピーできます:
- 所有者
- マネージャ
- 貢献者
- ダウンロード実行者
この操作を起動するには、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが次のいずれかのロールを持っている必要があります:
- CECStandardUser
- CECEnterpriseUser
電子メール通知
サイト・ガバナンスが有効になっている場合、サイトをコピーするリクエストにより、サイト・コピーを承認できる電子メール通知がユーザーに送信されることがあります。 自動承認されたリクエストでは電子メール通知が送信されませんが、管理者または指定ユーザーの承認が必要なリクエストでは通知が送信されます。 承認者のプリファレンスによって「サイトの作成を承認することを他のユーザーがリクエストしたときに電子メールを送信」通知が許可されている場合、eメール通知が承認者に送信されます。 すべてのユーザーに対して通知が無効になっている場合は、電子メール通知は送信されません。 Eメール通知は、「通知の抑止」リクエスト・ヘッダーを用意することによって抑制できます。 このリクエスト・ヘッダーが存在すると、ユーザー・プリファレンスに関係なく、すべての電子メール通知が生成されなくなります。
自動承認
サイト・ガバナンスが有効になっている場合、特定の状況下では、承認が必要なサイトのコピー・リクエストを自動的に承認できます。 認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが、リクエストの承認を許可されているユーザーの1つである場合、リクエストを自動的に承認できます。 たとえば、認証されたユーザーまたはクライアント・アプリケーションにサイト管理者ロールがあり、サイト・コピーに管理者承認が必要な場合、リクエストをすぐに承認できます。 自動承認を有効にするには、「自動承認リクエスト」リクエスト・ヘッダーを含めます。 このヘッダーを使用しない場合、サイトのコピー・リクエストは、レビューが追加されるまで「保留中」のままになります。 リクエストが自動的に承認された場合、電子メール通知は送信されません。
サイト・コピー・リクエストの進行状況の取得
サイト・ガバナンスが無効になっている場合、サイトのコピーがただちに開始され、サイト・ジョブ・ステータス・リソースから進捗をモニターできます。
詳細は、「サイト関連ジョブの進捗の取得」を参照してください。
サイト・ガバナンスを使用したサイトのコピー・リクエストの進行状況の取得
サイト・ガバナンスが有効になっている場合、サイトのコピーに承認が必要で、「ジョブ・ステータスのリソース」ではリクエストが承認されるまでblocked
ジョブの進捗状況がレポートされます。 リクエストが承認されると、サイト処理が開始され、ステータス・リソースを使用して進捗をモニターできます。 ステータスがsucceeded
に変わると、サイトは作成されています。 リクエストは、Location
ヘッダーに戻されたステータス・リソースのrequest
リンクを使用して識別できます。 リクエストに対するその後の操作(承認されるようにレビューをリクエストに追加するなど)を実行できます。
詳細は、「リクエストの進行状況の確認」を参照してください。
非同期処理
この操作「のみ」非同期処理をサポートしています。 respond-async
の値を持つPrefer
ヘッダーがリクエストに含まれている必要があります。 「承認済」レスポンスにはLocation
ヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。
ステータスの読取りの詳細は、「サイト関連ジョブの進捗の取得」を参照してください。
パス代替識別子
「サイト」リソースのデフォルトの識別子は、「サイト識別子」です。 サイト・リソースは代替識別子をサポートしています。
nameサイト名
サイト識別子のかわりに、サイト名を使用してリソース・パスのサイトを一意に識別できます。 サイトのデフォルトのリソース・パス・パラメータはサイト識別子ですが、サイトでの作業時には判読可能なサイト名が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/copy
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
202Accepted - Copy a Standard Site
標準サイトをコピーするには、サイト名が必要です。 コピーには、必要に応じてコピーされたサイトからの更新を含めることができます。 コピーされたサイトの説明は、必要に応じて指定することもできます。
リクエスト
POST https://api.example.com/sites/management/api/v1/sites/{id}/copy
リクエスト・ヘッダー
Prefer=respond-async
リクエスト本文
{ "name": "AcmeProductLaunch2020", "description": "Marketing site for Acme New Product Launch 2020.", "includeUpdates": true }
202確定済 - エンタープライズ・サイトのコピー
エンタープライズ・サイトをコピーするには、サイト名が必要です。 コピーには、必要に応じてコピーされたサイトからの更新を含めることができます。 コピーするサイトに関連付けられているリポジトリとリポジトリが異なる必要がある場合は、リポジトリを指定できます。 コピーするサイト・プレフィクスを指定できます。 コピーされたサイトの説明は、必要に応じて指定することもできます。
リクエスト
POST https://api.example.com/sites/management/api/v1/sites/{id}/copy
リクエスト・ヘッダー
Prefer=respond-async
リクエスト本文
{ "name": "AcmeProductLaunch2020", "description": "Marketing site for Acme New Product Launch 2020.", "includeUpdates": false, "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "sitePrefix": "News" }
202確定済 - サイトのコピーおよびEメール通知の抑制
通常は承認者に送信されるEメール通知を抑制するサイトをコピーします。
リクエスト
POST https://api.example.com/sites/management/api/v1/sites/{id}/copy
リクエスト・ヘッダー
Prefer=respond-async X-Suppress-Notifications=true
リクエスト本文
{ "name": "AcmeProductLaunch2020", "description": "Marketing site for Acme New Product Launch 2020.", "includeUpdates": true }リリース20.1.3で導入されました。
202確定済 - サイトをコピーしてリクエストを自動的に承認
認証されたユーザーがリクエストを承認できる場合は、サイトをコピーし、サイトをコピーするリクエストを自動的に承認します。
リクエスト
POST https://api.example.com/sites/management/api/v1/sites/{id}/copy
リクエスト・ヘッダー
X-Auto-Approve-Request=true Prefer=respond-async
リクエスト本文
{ "name": "AcmeProductLaunch2020", "description": "Marketing site for Acme New Product Launch 2020.", "includeUpdates": true }リリース20.1.3で導入されました。
クライアント・エラー・レスポンスの例
この操作は次のクライアント・エラー(4xx)レスポンスで応答しますが、レスポンス本文に例外の詳細が示されるか、非同期ジョブを通じてレポートされます。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
400Bad Request - Invalid Site Name
指定されたサイト名に使用できません。使用できる文字または語が含まれています。 サイト名が無効な理由がエラー・メッセージにレポートされます。
エラー・コード
OCE-SITEMGMT-009012
解決 - スペースの削除
サイト名を変更して、空白が含まれないようにしてください。
解決 - チェック文字
サイト名に使用できるのは、文字、数字、ハイフンおよびアンダースコアのみです。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
siteName | 無効なサイト名です。 |
reason | サイト名が無効な理由。 有効な値は次のとおりです。
|
この例外の詳細タイプの詳細は、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つが所有者である必要があります。 有効な値は次のとおりです。
|
この例外の詳細タイプの詳細は、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 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 - 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" } }
400不正なリクエスト - ハイブリッド・リンクをコピーできません
ハイブリッド・リンクをコピーできません。
エラー・コード
OCE-SITEMGMT-009104
解決 - 壊れたリンクを修正
サイト・ページ内のリンクを確認し、破損したリンクを修正します。
このエラーが返される場所
- このエラー「行わない」がレスポンス本文に返されます。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
linkId | コピーできないハイブリッド・リンクのID。 |
folderId | ハイブリッド・リンクを含むフォルダのID。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのCopyHybridLinkExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Unable to Copy Hybrid Link", "status": "400", "detail": "Unable to copy hybrid link.", "o:errorCode": "OCE-SITEMGMT-009104", "linkId": "value", "folderId": "value" }
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不正なリクエスト - 未公開サイト・アイテム
サイトで使用されている一部のコンテンツはサイトのチャネルに公開されていません。
エラー・コード
OCE-SITEMGMT-009137
解決 - コンテンツの公開
すべてのコンテンツがターゲット設定され、サイト・チャネルに公開されていることを確認します。
このエラーが返される場所
- このエラー「行わない」がレスポンス本文に返されます。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Unpublished Site Items", "status": "400", "detail": "Some content used by the site has not been published to the site's channel.", "o:errorCode": "OCE-SITEMGMT-009137" }
400不正なリクエスト - サイト・コンテンツをエクスポートできません
サイト・コンテンツ・アセットはエクスポートできません。
エラー・コード
OCE-SITEMGMT-009138
このエラーが返される場所
- このエラー「行わない」がレスポンス本文に返されます。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
siteName | サイト名。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteContentExportErrorExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Unable to Export Site Content", "status": "400", "detail": "The site's content assets cannot be exported.", "o:errorCode": "OCE-SITEMGMT-009138" }
403Forbidden - Inactive Policy
操作のポリシーが非アクティブであるため、操作が許可されないことを示します。
エラー・コード
OCE-SITEMGMT-009071
解決 - ポリシーがアクティブであることの確認
サイト管理者を取得して、操作に関連付けられているポリシーがアクティブとしてマークされていることを確認します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
policy | この操作を制御しているポリシー。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInactivePolicyExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Inactive Policy", "status": "403", "detail": "The policy for this operation is inactive.", "o:errorCode": "OCE-SITEMGMT-009071", "policy": { "id": "721af08b-32db-4eee-b6af-0c38d3ba4681" } }
403Forbidden - Restricted Policy
操作のポリシーが制限されているため、操作が許可されないことを示します。
エラー・コード
OCE-SITEMGMT-009072
解決 - アクセス・リストへのユーザーの追加
サイト管理者を取得し、ポリシー・アクセス・リストのメンバーとしてユーザーまたはクライアント・アプリケーションを追加します。
解決 - ポリシーを全員のアクセスに変更
サイト管理者を取得して、ポリシーaccessType
をeveryone
に変更します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
policy | この操作を制御しているポリシー。 |
user | ポリシー・アクセス・リストのメンバーではないユーザーまたはアプリケーション。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのRestrictedPolicyExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Restricted Policy", "status": "403", "detail": "The policy for the operation has a restricted audience and can't be used by the user or client application.", "o:errorCode": "OCE-SITEMGMT-009072", "policy": { "id": "721af08b-32db-4eee-b6af-0c38d3ba4681" }, "user": { "id": "1234" } }
403Forbidden - Site Operation Forbidden
サイト内で共有ロールを持つユーザーは、この操作を実行できません。
エラー・コード
OCE-SITEMGMT-009026
解決 - 共有ロールの変更
認証ユーザーに付与された共有ロールを必要なロール以上に変更します。
解決 - アプリケーション・ロールの変更
ユーザーにStandardユーザーまたはエンタープライズ・ユーザー・アプリケーション・ロールがあることを確認します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 操作が実行されているサイト。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteOperationForbiddenExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Operation Forbidden", "status": "403", "detail": "You do have a sharing role in this site, but your role does not allow you to use this operation.", "o:errorCode": "OCE-SITEMGMT-009026", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
リリース19.1.5.での導入。
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 | サイト管理者のみが作成できるリソース・タイプ。 有効な値は次のとおりです。
|
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で導入されました。
403禁止 - 詳細なセキュリティ操作禁止
詳細なセキュリティ制限により、SSTサイトのコピーなど、サイトまたはテンプレートでこの操作を実行できません。
エラー・コード
OCE-SITEMGMT-009148
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 操作が実行されているサイト。 |
template | 操作が実行されているテンプレート。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのGranularSecurityOperationForbiddenExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Granular Security Operation Forbidden", "status": "403", "detail": "Granular security operation forbidden for the site or template.", "o:errorCode": "OCE-SITEMGMT-009148", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" }, "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" } }
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。
404Not Found - Site Not Found
サイトが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションがサイトへのアクセス権を持っていません。
エラー・コード
OCE-SITEMGMT-009003
解決 - 識別子のチェック
サイト識別子が有効であることを確認してください。
解決 - メンバーシップのチェック
認証済ユーザーがサイトのメンバーまたはサイト管理者であることを確認します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 存在しないか、認証されたユーザーが参照できないサイトです。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Not Found", "status": "404", "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.", "o:errorCode": "OCE-SITEMGMT-009003", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
404Not Found - User Not Found
ユーザーが存在しません。
エラー・コード
OCE-IDS-001001
このエラーが返される場所
- このエラー「行わない」がレスポンス本文に返されます。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
user | 存在しないユーザー。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのUserNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "User Not Found", "status": "404", "detail": "User does not exist.", "o:errorCode": "OCE-IDS-001001", "user": { "id": "1234" } }
409Conflict - Site Deleted
ソフト削除されたサイトでは操作を実行できません。 このエラーは、includeDeleted
問合せパラメータがtrue
に設定されている場合にのみ発生します。
エラー・コード
OCE-SITEMGMT-009059
解決 - サイトのリストア
サイトをリストアしてから操作を再試行してください。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | サイト識別子が指定されている場合、ソフト削除されるサイト。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteDeletedExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Deleted", "status": "409", "detail": "The operation cannot be performed as the site has been soft deleted.", "o:errorCode": "OCE-SITEMGMT-009059", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
リリース19.4.1.での導入。
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 | フィールドが必須であるか、禁止されていることを示します。 有効な値は次のとおりです。
|
この例外の詳細タイプの詳細は、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" }
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競合 - サイト・コンテンツ準備中
サイトには準備ができていない状態のコンテンツ・アセットが含まれます。
エラー・コード
OCE-SITEMGMT-009144
このエラーが返される場所
- このエラー「行わない」がレスポンス本文に返されます。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 操作が実行されているサイト。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteContentNotReadyErrorExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Content Not Ready", "status": "409", "detail": "The site contains content assets in a \"not ready\" state.", "o:errorCode": "OCE-SITEMGMT-009144", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
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で導入されました。
リクエスト
- application/json
- id: string
サイトの不変の識別子。
- includeDeleted(optional): boolean
削除対象としてマークされているリソースでは、この問合せパラメータが
true
に設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。includeDeleted
問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。
- Prefer(optional): string
respond-async
ヘッダー値を使用してリクエストの非同期処理をリクエストします。 - X-Auto-Approve-Request(optional): boolean
サイト・ガバナンスが有効なときにサイトを作成またはコピーするリクエストが行われると、そのリクエストは自動承認されます。 認証されたユーザーがリクエストの承認を許可されているユーザーのいずれかである場合、リクエストは自動的に承認されます。 たとえば、認証されたユーザーがサイト管理者ロールを持ち、サイトが管理者の承認を必要とする場合、リクエストを自動的に承認できます。 ユーザーがリクエストを承認できない場合、ヘッダーが含まれます。 自動承認を有効にするには、有効な場合、このヘッダーを値
true
でリクエストに追加します。 - X-Suppress-Notifications(optional): boolean
リクエストごとに通知が送信されないようにするクライアントの場合、このヘッダーは値
true
に設定できます。 通知が通常送信される場合でも、このヘッダーによってリクエストの通知配信が抑制されます。 - X-Suppress-Site-Governance(optional): boolean
サイト管理者がサイト関連の操作でポリシーを渡すと、サイトのガバナンス抑制ヘッダーをリクエストの値
true
に設定できます。 ポリシーがinactive
の場合でも、このヘッダーが設定されている場合は、サイト管理者が操作を実行できます。 承認のタイプや、サイト・プレフィクスの指定などの操作の制限などのその他のポリシー管理も抑制されます。
サイトをコピーするために必要な詳細。 少なくとも新規サイト名を指定する必要があります。
object
- description(optional): string
最大長:
1000
サイトの説明は、サイトの目的や使用状況をユーザーが理解するのに役立ちます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
リリース19.1.5.での導入。 - includeUpdates(optional): boolean
未公開の更新内容をコピーに含めます。
リリース19.2.2.での導入。 - justification(optional): string
最大長:
1000
理由は、承認者がこのリクエストをレビューするのに役立ちます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
- links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
- name: string
最大長:
242
この名前はサイト作成プロセスで使用され、新しいサイトの識別に使用されます。 名前は一意である必要があります。指定した名前は既存のサイトの名前と同じにできません。
リリース19.1.5.での導入。 - ownedBy(optional): string
サイトを所有するユーザーまたはクライアント・アプリケーションを取得します。 サイトを所有するユーザーまたはクライアント・アプリケーションは、別のユーザーのかわりにリクエストが作成された場合にリクエストを作成したユーザーまたはクライアント・アプリケーションとは異なる場合があります。
リリース19.1.5.での導入。 - repository(optional): string
サイトの作成時にサイトに関連付けられるアセット・リポジトリ。 リポジトリは、エンタープライズ・サイトに対してのみ設定できます。 リクエストに関連付けられているポリシーでリポジトリが指定されている場合、リポジトリをリクエストに関連付けることはできません。
リリース19.2.3.での導入。 - sitePrefix(optional): string
最大長:
15
サイトの作成時にサイトに設定されるサイト・プレフィクス。 エンタープライズ・サイトのリクエストにのみ設定されます。 リクエストに関連付けられているポリシーで許可されている場合のみ設定できます。そうでない場合、サイト・プレフィクスが自動的に生成されます。 サイト・プレフィクスの長さは15文字までです。
リリース19.2.3.での導入。
{
"name":"AcmeProductLaunch2020",
"description":"Marketing site for Acme New Product Launch 2020.",
"includeUpdates":true
}
array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
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
とみなすことができます。
レスポンス
202レスポンス
400レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object InvalidSiteNameExceptionDetail-allOf[1]
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ページなどの問題の判読可能なサマリーを提供します。
object
- reason(optional): string
サイト名が無効な理由。
有効な値は次のとおりです。
-
tooLong
- 名前が長すぎます。 -
invalidCharacters
- 名前に無効な文字が含まれています -
startWithSpace
- 名前が空白で始まります -
endWithSpace
- 名前が空白で終わる -
internalWord
- 名前が制限付きの内部語である -
empty
- 名前が空です
-
- siteName(optional): string
最大長:
242
無効なサイト名です。
- object 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 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"
}
401レスポンス
403レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object InactivePolicyExceptionDetail-allOf[1]
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ページなどの問題の判読可能なサマリーを提供します。
object
- policy(optional): string
この操作を制御しているポリシー。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Inactive Policy",
"status":"403",
"detail":"The policy for this operation is inactive.",
"o:errorCode":"OCE-SITEMGMT-009071",
"policy":{
"id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Restricted Policy",
"status":"403",
"detail":"The policy for the operation has a restricted audience and can't be used by the user or client application.",
"o:errorCode":"OCE-SITEMGMT-009072",
"policy":{
"id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
},
"user":{
"id":"1234"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Operation Forbidden",
"status":"403",
"detail":"You do have a sharing role in this site, but your role does not allow you to use this operation.",
"o:errorCode":"OCE-SITEMGMT-009026",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
{
"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"
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Granular Security Operation Forbidden",
"status":"403",
"detail":"Granular security operation forbidden for the site or template.",
"o:errorCode":"OCE-SITEMGMT-009148",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
},
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
}
}
404レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object SiteNotFoundExceptionDetail-allOf[1]
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ページなどの問題の判読可能なサマリーを提供します。
object
- site(optional): string
存在しないか、認証されたユーザーが参照できないサイトです。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Not Found",
"status":"404",
"detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
"o:errorCode":"OCE-SITEMGMT-009003",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
409レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object SiteDeletedExceptionDetail-allOf[1]
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ページなどの問題の判読可能なサマリーを提供します。
object
- site(optional): string
サイト識別子が指定されている場合、ソフト削除されるサイト。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Deleted",
"status":"409",
"detail":"The operation cannot be performed as the site has been soft deleted.",
"o:errorCode":"OCE-SITEMGMT-009059",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
{
"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":"Starter Edition Limit Reached",
"status":"409",
"detail":"Starter edition will only allow you to create one site.",
"o:errorCode":"OCE-SITEMGMT-009117"
}