機械翻訳について

テーマのコピー

post

/sites/management/api/v1/themes/{id}/copy

EXTENDED OPERATION

テーマをコピーするには、新しいテーマ名とオプションの説明を指定します。 テーマ名は大文字と小文字が区別され、2つのテーマは同じ名前を共有できません。 テーマ名に使用できるのは、文字、数字、ハイフンおよびアンダースコアのみです。 テーマのコピーでは、すべてのテーマ・アーティファクトを含むテーマ・フォルダもコピーされます。

リリース19.4.1.での導入。

認可

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

  • 所有者
  • マネージャ
  • 貢献者
  • ダウンロード実行者

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

  • CECDeveloperUser
  • CECSitesAdministrator
  • CECContentAdministrator

非同期処理

この操作では、「両方の」非同期および同期処理がサポートされます。 クライアントは、値respond-asyncPreferヘッダーを追加することで、優先相互作用モードを指定できます。 サーバーは非同期リクエストを同期に変更できるため、両方のケースを処理するためにクライアントを準備する必要があります。 「承認済」レスポンスにはLocationヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。

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

パス代替識別子

「テーマ」リソースのデフォルトの識別子は、「テーマ識別子」です。 テーマ・リソースは代替識別子をサポートしています。

nameテーマ名

テーマ識別子のかわりに、テーマ名を使用して、リソース・パスのテーマを一意に識別できます。 テーマのデフォルトのリソース・パス・パラメータはテーマ識別子ですが、テーマで作業すると、判読可能なテーマ名の方が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/themes/name:LearnTheme/copy

リリース19.4.1.での導入。

成功したレスポンスの例

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

201Created - Copy a Theme Specifying a Name and Description

コピーの新しい名前と説明を指定して、テーマをコピーします。

リクエスト

POST https://api.example.com/sites/management/api/v1/themes/{id}/copy

リクエスト本文

{
  "name": "LearnThemeCopy",
  "description": "A copy of the learn theme."
}

202確定済 - 名前と説明を非同期で指定するテーマのコピー

コピーに新しい名前と説明を指定してテーマをコピーします。

リクエスト

POST https://api.example.com/sites/management/api/v1/themes/{id}/copy

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "name": "LearnThemeCopy",
  "description": "A copy of the learn theme."
}

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

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

400Bad Request - Invalid Theme Name

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

エラー・コード

OCE-SITEMGMT-009052

解決 - スペースの削除

空白が含まれないようにテーマ名を変更してください。

解決 - チェック文字

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

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

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

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

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

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

リリース19.4.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で導入されました。

404Not Found - Theme Not Found

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

エラー・コード

OCE-SITEMGMT-009041

解決 - 識別子のチェック

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

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

認証されたユーザーがテーマのメンバーであることを確認します。

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

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

フィールド名説明
theme存在しないか、認証されたユーザーに表示されないテーマ。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Not Found",
  "status": "404",
  "detail": "Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.",
  "o:errorCode": "OCE-SITEMGMT-009041",
  "theme": {
    "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
  }
}

リリース19.4.1.での導入。

409Conflict - Theme Already Exists

同じ名前またはアイデンティティのテーマがすでに存在します。 テーマ名およびIdは、すべてのテーマ間で一意である必要があります。

エラー・コード

OCE-SITEMGMT-009042

解決 - テーマ名の変更

コピーまたは名前の変更中に名前を衝突する場合は、別の名前を選択してください。

解決 - 競合解決名の変更

インポート中に名前を付ける場合は、テーマの競合解決に別の名前を選択してください。

解決 - 競合解決アクションの変更

インポート中にアイデンティティを衝突する場合は、テーマの競合解決タイプをoverwritecreateまたはskipに変更します。

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

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

フィールド名説明
themeテーマが重複しています。
name重複している名前です
itemGuidアイデンティティGUIDが重複しています。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Already Exists",
  "status": "409",
  "detail": "A theme with the same name or identity already exists.",
  "o:errorCode": "OCE-SITEMGMT-009042",
  "theme": {
    "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
  },
  "name": "CafeSupremoTheme",
  "itemGuid": "value"
}

リリース19.4.1.での導入。

409Conflict - Theme Deleted

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

エラー・コード

OCE-SITEMGMT-009062

解決 - テーマのリストア

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

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

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

フィールド名説明
themeソフト削除されたテーマ。

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

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

リリース19.4.1.での導入。

409Conflict - Theme Import In Progress

このエラーは、テーマがコピーまたは公開されているが、テンプレートのインポートによって上書きされる場合に発生します。

エラー・コード

OCE-SITEMGMT-009106

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

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

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

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

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

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

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

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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
問合せパラメータ
  • 削除対象としてマークされているリソースでは、この問合せパラメータがtrueに設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。 includeDeleted問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。

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

本文()

コピーの詳細。

ルート・スキーマ: schema
型: object
ソースを表示
  • 最大長: 1000

    オプションの説明。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

    リリース19.4.1.での導入。
  • 最大長: 255

    テーマの名前。

    リリース19.4.1.での導入。
例:
{
    "name":"LearnThemeCopy",
    "description":"A copy of the learn theme."
}
トップに戻る

レスポンス

201レスポンス

作成日
ヘッダー

202レスポンス

Accepted
ヘッダー

400レスポンス

不正なリクエスト
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : InvalidThemeNameExceptionDetail
リリース19.4.1.での導入。
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

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

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

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

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

  • o:errorDetails

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

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

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

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

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

ネストされたスキーマ : InvalidThemeNameExceptionDetail-allOf[1]
型: object
ソースを表示
  • テーマ名が無効な理由。

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

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

    リリース19.4.1.での導入。
  • 最大長: 255

    テーマ名が無効です。

    リリース19.4.1.での導入。
ネストされたスキーマ: o:errorDetails
型: array

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

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

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

レスポンスの例(無効なテーマ名)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Theme Name",
    "status":"400",
    "detail":"Theme name '{themeName}' cannot be used to create a theme.",
    "o:errorCode":"OCE-SITEMGMT-009052",
    "themeName":"CafeSupremoTheme",
    "reason":"tooLong"
}

401レスポンス

未認可

403レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

レスポンスの例(ストレージ制限に達しました)
{
    "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
}
レスポンスの例(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"
}

404レスポンス

見つかりません
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : ThemeNotFoundExceptionDetail
リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • ExceptionDetail

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

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

ネストされたスキーマ : ThemeNotFoundExceptionDetail-allOf[1]
型: object
ソースを表示
  • 存在しないか、認証されたユーザーに表示されないテーマ。

    リリース19.4.1.での導入。
ネストされたスキーマ: o:errorDetails
型: array

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

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

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

レスポンスの例(テーマが見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Not Found",
    "status":"404",
    "detail":"Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.",
    "o:errorCode":"OCE-SITEMGMT-009041",
    "theme":{
        "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
    }
}

409レスポンス

競合
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : ThemeAlreadyExistsExceptionDetail
リリース19.4.1.での導入。
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

レスポンスの例(テーマはすでに存在します)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Already Exists",
    "status":"409",
    "detail":"A theme with the same name or identity already exists.",
    "o:errorCode":"OCE-SITEMGMT-009042",
    "theme":{
        "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
    },
    "name":"CafeSupremoTheme",
    "itemGuid":"value"
}
レスポンスの例(テーマが削除されました)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the theme has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009062",
    "theme":{
        "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
    }
}
レスポンスの例(インポート進行中)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Import In Progress",
    "status":"409",
    "detail":"Unable to access theme as it is in the progress of being re-imported.",
    "o:errorCode":"OCE-SITEMGMT-009106",
    "importedBy":"value",
    "name":"CafeSupremoTheme"
}

413 レスポンス

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

415 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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