サイト管理用のREST API

サイトの翻訳ジョブの作成

post

/sites/management/api/v1/sites/{id}/translate

EXTENDED OPERATION

サイト翻訳をエクスポートし、サイトの新しい翻訳ジョブを作成します。サイト・チャネルのローカリゼーション・ポリシーにある言語のみを指定できます。翻訳ジョブのソース言語は、サイトのデフォルト言語になります。デフォルト言語が設定されていないサイトでは、翻訳ジョブを作成できません。サイト用に作成された翻訳ジョブは、一意の名前を持つ必要があります。

リリース19.4.3での導入。

認可

サイト翻訳ジョブは、サイトとそのリポジトリの両方で少なくともコントリビュータ・ロールを持っているユーザーによって作成できます。エクスポート・プロセスを開始するには、ユーザーをサイトと共有し、次のいずれかの「共有」ロールを持っている必要があります:

所有者
マネージャ
貢献者

翻訳の作成ジョブのモニター

新しいサイト翻訳ジョブを作成するリクエストが受け入れられたら、レスポンスLocationヘッダーに指定されているジョブ・ステータス・リソースを読み取ることで、リクエストの進捗状況を監視できます。

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

翻訳のダウンロード

サイト翻訳をエクスポートすると、作成された翻訳ZIPファイルの詳細を読むことができます。レスポンスには、ファイル・データをストリームするために使用できるdownloadリンクが含まれます。

詳細は、「翻訳ジョブの翻訳ファイルの詳細の取得」を参照してください。

翻訳のインポート

翻訳をインポートするには、ZIPファイルに翻訳を追加し、個人フォルダにファイルをアップロードします。その後、翻訳をインポートできます。

詳細は、「サイト翻訳のインポート」を参照してください。

非同期処理

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

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

パス代替識別子

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

nameサイト名

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

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/translate

リリース19.4.1.での導入。

成功したレスポンスの例

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

202Accepted - Translate a Site into French and German

フランス語およびドイツ語用の翻訳ジョブを作成します。すべてのサイト・コンテンツおよびターゲット設定されたアセットが翻訳ジョブに含まれます。

リクエスト

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

リクエスト本文

{
  "name": "AcmeProductLaunch_FrenchGerman_Translations",
  "type": "complete",
  "targetLanguages": [
      "fr",
      "de"
  ]
}

202確定済 - サイト・コンテンツをスペイン語に翻訳

サイト・コンテンツのみのスペイン語の翻訳ジョブを作成します。ターゲット・アセットは翻訳ジョブに含まれません。

リクエスト

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

リクエスト本文

{
  "name": "AcmeProductLaunch_SpanishContent_Translations",
  "type": "content",
  "targetLanguages": [
      "es"
  ]
}

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

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

400不正なリクエスト - 無効なターゲット言語

ターゲット言語はローカリゼーション・ポリシーに含まれている必要があります。

エラー・コード

OCE-CAAS-001015

解決 - ターゲット言語の変更

ターゲット言語をローカリゼーション・ポリシーの1つ以上の言語に変更します。

このエラーが返される場所

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

例外詳細フィールド

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

フィールド名	説明
`invalidLanguages`	無効な言語です。
`localizationPolicy`	ローカリゼーション・ポリシー。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Target Language",
  "status": "400",
  "detail": "The target languages must be in the localization policy.",
  "o:errorCode": "OCE-CAAS-001015",
  "invalidLanguages": [
      "en-US"
  ],
  "localizationPolicy": {
    "id": "7D77CB6653BC1FF8E0530100007F6630"
  }
}

リリース19.4.3での導入。

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.での導入。

403禁止 - リポジトリ操作は禁止されています

リポジトリ内の共有ロールでは操作を実行できません。認証されたユーザーまたはクライアント・アプリケーションはリポジトリ・リソースの読取りを許可されていますが、ユーザーがリポジトリに指定されている共有ロールでは操作を実行できません。

エラー・コード

OCE-CAAS-001012

解決 - 共有ロールの変更

認証されたユーザーまたはクライアント・アプリケーションに付与された共有ロールを、必要なロール以上に変更します。

このエラーが返される場所

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

例外詳細フィールド

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

フィールド名	説明
`repository`	操作が実行されているサイト。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Repository Operation Forbidden",
  "status": "403",
  "detail": "You do have a sharing role in this repository, but your role does not allow you to use this operation.",
  "o:errorCode": "OCE-CAAS-001012",
  "repository": {
    "id": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
  }
}

リリース19.4.3での導入。

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で導入されました。

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"
  }
}

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 - Missing Site Default Language

この操作を実行するには、サイトのデフォルトが必要です。

エラー・コード

OCE-SITEMGMT-001008

このエラーが返される場所

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Missing Site Default Language",
  "status": "409",
  "detail": "Default language for the site is missing.",
  "o:errorCode": "OCE-SITEMGMT-001008"
}

リリース19.4.1.での導入。

409Conflict - Missing Site Localization Policy

この操作を実行するには、サイトにローカリゼーション・ポリシーが必要です。

エラー・コード

OCE-SITEMGMT-009074

このエラーが返される場所

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Missing Site Localization Policy",
  "status": "409",
  "detail": "Localization policy for site is missing.",
  "o:errorCode": "OCE-SITEMGMT-009074"
}

リリース19.4.1.での導入。

409競合 - 翻訳ジョブはすでに存在

同じ名前の翻訳ジョブがすでに存在します。

エラー・コード

OCE-CAAS-001013

解決 - 翻訳ジョブ名の編集

既存の翻訳ジョブと衝突しないように、リクエストの翻訳ジョブ名を編集します。

このエラーが返される場所

このエラー「行わない」がレスポンス本文に返されます。
このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

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

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Translation Job Already Exists",
  "status": "409",
  "detail": "Translation job with name '{name}' already exists.",
  "o:errorCode": "OCE-CAAS-001013",
  "name": "Oracle Content and Experience"
}

リリース19.4.3での導入。

409Conflict - Site Asset Translation Not Supported

サイト・アセットの翻訳はサイトではサポートされていません。

エラー・コード

OCE-SITEMGMT-009082

解決 - 翻訳タイプの変更

typeパラメータの値をcontentに変更します。

このエラーが返される場所

このエラー「行わない」がレスポンス本文に返されます。
このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Asset Translation Not Supported",
  "status": "409",
  "detail": "Translation of site assets is not supported for the site.",
  "o:errorCode": "OCE-SITEMGMT-009082"
}

リリース19.4.3での導入。

リクエスト

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

application/json

パス・パラメータ

id: string

サイトの不変の識別子。

問合せパラメータ

includeDeleted(optional): boolean

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

ヘッダー・パラメータ

Prefer(optional): string

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

作成するサイト翻訳ジョブの詳細。

ルート・スキーマ: schema

型: object

ソースを表示

name: string

翻訳ジョブを指定する名前。
リリース19.4.3での導入。
targetLanguages: array targetLanguages

ターゲット言語。
リリース19.4.3での導入。
type: string
翻訳タイプ。
有効な値は次のとおりです。
- complete - コンテンツを含む完全なサイトとすべてのターゲット・アセットが翻訳されます
- content - サイト・コンテンツのみが翻訳されます
- assets - サイト公開チャネルをターゲットにしたアセットのみが翻訳されます
リリース19.4.3での導入。

{
    "type":"object",
    "properties":{
        "name":{
            "description":"<p>Name to give the translation job.</p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Translation type.</p><p>Valid values are:\n<ul><li> <code>complete</code> - Complete site including content and all targeted assets will be translated</li><li> <code>content</code> - Only site content will be translated</li><li> <code>assets</code> - Only assets targeted to the site's publishing channel will be translated</li></p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "targetLanguages":{
            "description":"<p>Target languages.</p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "name",
        "type",
        "targetLanguages"
    ],
    "example":{
        "name":"AcmeProductLaunch_FrenchGerman_Translations",
        "type":"complete",
        "targetLanguages":[
            "fr",
            "de"
        ]
    }
}

例:

{
    "name":"AcmeProductLaunch_FrenchGerman_Translations",
    "type":"complete",
    "targetLanguages":[
        "fr",
        "de"
    ]
}

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

型: array

ターゲット言語。

リリース19.4.3での導入。

ソースを表示

Array of: string

{
    "description":"<p>Target languages.</p><small>Introduced in release 19.4.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

トップに戻る

レスポンス

202レスポンス

Accepted

ヘッダー

Location: string

リソースのロケーション。

400レスポンス

不正なリクエスト

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf InvalidTargetLanguagesExceptionDetail

リリース19.4.3での導入。

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

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

リリース19.4.3での導入。

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"<small>Introduced in release 19.4.3.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "invalidLanguages":{
                    "description":"<p>Invalid languages.</p><small>Introduced in release 19.4.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "localizationPolicy":{
                    "description":"<p>Localization policy.</p><small>Introduced in release 19.4.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

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

ソースを表示

detail(optional): string

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

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

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

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

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

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

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

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

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

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

型: object

ソースを表示

invalidLanguages(optional): array invalidLanguages

無効な言語です。
リリース19.4.3での導入。
localizationPolicy(optional): string

ローカリゼーション・ポリシー。
リリース19.4.3での導入。

{
    "properties":{
        "invalidLanguages":{
            "description":"<p>Invalid languages.</p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "localizationPolicy":{
            "description":"<p>Localization policy.</p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: array

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

ソースを表示

Array of: items

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

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

すべてに一致

ソースを表示

object ExceptionDetail

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

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

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

型: array

無効な言語です。

リリース19.4.3での導入。

ソースを表示

Array of: string

{
    "description":"<p>Invalid languages.</p><small>Introduced in release 19.4.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

レスポンスの例(無効なターゲット言語)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Target Language",
    "status":"400",
    "detail":"The target languages must be in the localization policy.",
    "o:errorCode":"OCE-CAAS-001015",
    "invalidLanguages":[
        "en-US"
    ],
    "localizationPolicy":{
        "id":"7D77CB6653BC1FF8E0530100007F6630"
    }
}

401レスポンス

未認可

403レスポンス

禁止

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf SiteOperationForbiddenExceptionDetail

リリース19.1.5.での導入。

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

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

リリース19.1.5.での導入。

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"<small>Introduced in release 19.1.5.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site on which the operation is being performed.</p><small>Introduced in release 19.1.5.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

detail(optional): string

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

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

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

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

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

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

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

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

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

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

型: object

ソースを表示

site(optional): string

操作が実行されているサイト。
リリース19.1.5.での導入。

{
    "properties":{
        "site":{
            "description":"<p>Site on which the operation is being performed.</p><small>Introduced in release 19.1.5.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: array

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

ソースを表示

Array of: items

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

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

すべてに一致

ソースを表示

object ExceptionDetail

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

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

レスポンスの例(サイト操作禁止)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"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":"Repository Operation Forbidden",
    "status":"403",
    "detail":"You do have a sharing role in this repository, but your role does not allow you to use this operation.",
    "o:errorCode":"OCE-CAAS-001012",
    "repository":{
        "id":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
    }
}

404レスポンス

見つかりません

ヘッダー

Cache-Control: string

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

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

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

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf SiteNotFoundExceptionDetail

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

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

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

detail(optional): string

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

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

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

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

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

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

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

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

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

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

型: object

ソースを表示

site(optional): string

存在しないか、認証されたユーザーが参照できないサイトです。

{
    "properties":{
        "site":{
            "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: array

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

ソースを表示

Array of: items

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

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

すべてに一致

ソースを表示

object ExceptionDetail

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

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

レスポンスの例(サイトが見つかりません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"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レスポンス

競合

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf SiteDeletedExceptionDetail

リリース19.4.1.での導入。

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site that is soft deleted, if the site identifier has been provided.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

detail(optional): string

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

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

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

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

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

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

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

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

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

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

型: object

ソースを表示

site(optional): string

サイト識別子が指定されている場合、ソフト削除されるサイト。
リリース19.4.1.での導入。

{
    "properties":{
        "site":{
            "description":"<p>Site that is soft deleted, if the site identifier has been provided.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: array

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

ソースを表示

Array of: items

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

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

すべてに一致

ソースを表示

object ExceptionDetail

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

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

レスポンスの例(サイト削除)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"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":"Missing Site Default Language",
    "status":"409",
    "detail":"Default language for the site is missing.",
    "o:errorCode":"OCE-SITEMGMT-001008"
}

レスポンスの例(サイト・ローカリゼーション・ポリシーがありません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Missing Site Localization Policy",
    "status":"409",
    "detail":"Localization policy for site is missing.",
    "o:errorCode":"OCE-SITEMGMT-009074"
}

413 レスポンス

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

415 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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

先頭に戻る