サイト管理用のREST API

サイトのコンテンツの検証

post

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

EXTENDED OPERATION

翻訳に関するエンタープライズ・サイトのページを検証してください。サイトが検証されると、ページがチェックされ、その翻訳がサイト・チャネルのローカリゼーション・ポリシーおよび言語詳細と一致しているかどうかが確認されます。ページの詳細ごとに、ページに翻訳の欠落および言語の欠落があるかどうかが示されます。ページで使用されるアセットも、アセットがドラフトか公開済かなど、各アセットのバージョンを示すリストに表示されます。

リリース19.4.1.での導入。

認可

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

所有者
マネージャ

パス代替識別子

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

nameサイト名

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

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

リリース19.4.1.での導入。

成功したレスポンスの例

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

200OK - Valid Site Results

検証結果には、siteinfo、structureページおよびホーム・ページの詳細が含まれます。

リクエスト

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

レスポンス本文

{
  "valid": false,
  "pages": [
      {
        "id": "siteinfo",
        "name": "siteinfo",
        "type": "siteinfo",
        "publishable": false,
        "languages": [
            {
              "language": "fr-FR",
              "policyStatus": "required",
              "validation": "missing"
            },
            {
              "language": "de-DE",
              "policyStatus": "optional",
              "validation": "ready"
            },
            {
              "language": "es-ES",
              "policyStatus": "undefined",
              "validation": "excluded"
            }
        ],
        "usedAssets": [
        ]
      },
      {
        "id": "structure",
        "name": "structure",
        "type": "structure",
        "publishable": false,
        "languages": [
            {
              "language": "fr-FR",
              "policyStatus": "required",
              "validation": "missing"
            },
            {
              "language": "de-DE",
              "policyStatus": "optional",
              "validation": "ready"
            },
            {
              "language": "es-ES",
              "policyStatus": "undefined",
              "validation": "excluded"
            }
        ],
        "usedAssets": [
        ]
      },
      {
        "id": "10",
        "name": "Home",
        "type": "page",
        "publishable": false,
        "languages": [
            {
              "language": "fr-FR",
              "policyStatus": "required",
              "validation": "missing"
            },
            {
              "language": "de-DE",
              "policyStatus": "optional",
              "validation": "ready"
            },
            {
              "language": "es-ES",
              "policyStatus": "undefined",
              "validation": "excluded"
            }
        ],
        "usedAssets": [
            {
              "id": "CORED2FDC62C23504F6AB47B1F6106F9DC73",
              "version": "draft"
            },
            {
              "id": "CORE48AF98371AFC4568B260D4417E38A739",
              "version": "published"
            },
            {
              "id": "CONTBD592905665C4652BFEAE6FD19E9F291",
              "version": "draft"
            },
            {
              "id": "CONT9DE7B749A5E9438689492A0054C02707",
              "version": "draft"
            }
        ]
      }
  ]
}

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

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

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

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

409Conflict - Invalid Site Default Language

サイトには、ローカリゼーション・ポリシーの必須言語と一致しないデフォルト言語があります。

エラー・コード

OCE-SITEMGMT-009075

例外詳細フィールド

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

フィールド名	説明
`defaultLanguage`	デフォルト言語が無効です。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Default Language",
  "status": "409",
  "detail": "Default Language '{defaultLanguage}' for site is not valid. The default language must be one of the localization policy's required languages.",
  "o:errorCode": "OCE-SITEMGMT-009075",
  "defaultLanguage": "en-US"
}

リリース19.4.1.での導入。

リクエスト

パス・パラメータ

id: string

サイトの不変の識別子。

問合せパラメータ

includeDeleted(optional): boolean

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

トップに戻る

レスポンス

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

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

200レスポンス

ヘッダー

Cache-Control: string

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

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

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

ルート・スキーマ: schema

すべてに一致

ソースを表示

object SiteValidationResult

サイト・チャネルに構成されたローカリゼーション・ポリシーに対するサイト・コンテンツ検証の結果。

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

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

型: object

サイト・チャネルに構成されたローカリゼーション・ポリシーに対するサイト・コンテンツ検証の結果。

ソースを表示

pages(optional): array pages

siteinfoおよび構造を含むページ・オブジェクトのリスト。
valid(optional): boolean

サイト検証処理の検証ステータス。 trueの値は、サイトが検証済であることを示します。

{
    "description":"<p>Result of site content validation against localization policy configured on site channel.</p>",
    "properties":{
        "valid":{
            "description":"<p>Validation status of the site validation processing. A value of <code>true</code> indicates the site is validate.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "pages":{
            "description":"<p>List of page objects including <code>siteinfo</code> and structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/SitePageValidationResult"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : ページ

型: array

siteinfoおよび構造を含むページ・オブジェクトのリスト。

ソースを表示

Array of: items

{
    "description":"<p>List of page objects including <code>siteinfo</code> and structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/SitePageValidationResult"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

object SitePageValidationResult

サイト・チャネルに構成されているローカリゼーション・ポリシーに対するサイト・コンテンツ検証の個々のページの結果。

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

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

型: object

サイト・チャネルに構成されているローカリゼーション・ポリシーに対するサイト・コンテンツ検証の個々のページの結果。

ソースを表示

id(optional): string

ページ識別子。
languages(optional): array languages

各サイト・ページの言語検証情報のリスト。 siteinfoページおよびstructureページは、このリストに含まれます。サイトのチャネル・ローカリゼーション・ポリシーに定義されているすべての言語と、ページが翻訳される言語をリストします。
name(optional): string

ページ名。
publishable(optional): boolean

ページが公開可能かどうかを示します。
type(optional): string

ページ・タイプ。
usedAssets(optional): array usedAssets

サイトで使用されるアセットのアセット検証情報のリスト。

{
    "description":"<p>Result for an individual page for site content validation against localization policy configured on site channel.</p>",
    "properties":{
        "id":{
            "description":"<p>Page identifier.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Page name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Page type.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "publishable":{
            "description":"<p>Indicates if the page is publishable or not.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "languages":{
            "description":"<p>List of language validation information for each site page. The <code>siteinfo</code> and <code>structure</code> pages are included in this list. Lists all languages defined in the site channel localization policy plus languages the page is translated into.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/LanguageValidationResult"
                    }
                ]
            }
        },
        "usedAssets":{
            "description":"<p>List of asset validation information for assets used by the site.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/UsedAsset"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : 言語

型: array

各サイト・ページの言語検証情報のリスト。 siteinfoページおよびstructureページは、このリストに含まれます。サイトのチャネル・ローカリゼーション・ポリシーに定義されているすべての言語と、ページが翻訳される言語をリストします。

ソースを表示

Array of: items

{
    "description":"<p>List of language validation information for each site page. The <code>siteinfo</code> and <code>structure</code> pages are included in this list. Lists all languages defined in the site channel localization policy plus languages the page is translated into.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/LanguageValidationResult"
            }
        ]
    }
}

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

型: array

サイトで使用されるアセットのアセット検証情報のリスト。

ソースを表示

Array of: items

{
    "description":"<p>List of asset validation information for assets used by the site.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/UsedAsset"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

object LanguageValidationResult

サイト・チャネルに構成されているローカリゼーション・ポリシーに対するサイト・コンテンツ検証の個々のページの結果。

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

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

型: object

サイト・チャネルに構成されているローカリゼーション・ポリシーに対するサイト・コンテンツ検証の個々のページの結果。

ソースを表示

language(optional): string

言語
policyStatus(optional): string
この言語のローカリゼーション・ポリシー検証ステータス。
有効な値は次のとおりです。
- required - 必要な言語翻訳がありません
- optional - 必須言語翻訳はオプションです
- undefined - ローカリゼーション・ポリシーで定義されていない言語
validation(optional): string
この言語の検証ステータス。
有効な値は次のとおりです。
- missing - ページ言語がありません
- ready - ページ言語準備完了
- excluded - 除外されるページ言語

{
    "description":"<p>Result for an individual page for site content validation against localization policy configured on the site channel.</p>",
    "properties":{
        "language":{
            "description":"<p>Language.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "policyStatus":{
            "description":"<p>Localization policy validation status for this language.</p><p>Valid values are:\n<ul><li> <code>required</code> - Required language translation is missing</li><li> <code>optional</code> - Required language translation is optional</li><li> <code>undefined</code> - Language not defined by localization policy</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "validation":{
            "description":"<p>Validation status for this language.</p><p>Valid values are:\n<ul><li> <code>missing</code> - Page language missing</li><li> <code>ready</code> - Page language ready</li><li> <code>excluded</code> - Page language excluded</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

すべてに一致

ソースを表示

object UsedAsset

サイト・ページで使用されるアセットに関する情報。

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

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

型: object

サイト・ページで使用されるアセットに関する情報。

ソースを表示

id(optional): string

アセット識別子。
version(optional): string
アセット・バージョン
有効な値は次のとおりです。
- draft - サイトの公開時にドラフトのアセットが公開されていません
- published - 公開されたアセットは、サイトの公開時に公開されます

{
    "description":"<p>Information about an asset used on a site page.</p>",
    "properties":{
        "id":{
            "description":"<p>Asset identifier.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "version":{
            "description":"<p>Asset version.</p><p>Valid values are:\n<ul><li> <code>draft</code> - A draft asset is <strong>not</strong> published during site publish</li><li> <code>published</code> - A published asset is published during site publish</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

レスポンスの例(有効なサイト結果)

{
    "valid":false,
    "pages":[
        {
            "id":"siteinfo",
            "name":"siteinfo",
            "type":"siteinfo",
            "publishable":false,
            "languages":[
                {
                    "language":"fr-FR",
                    "policyStatus":"required",
                    "validation":"missing"
                },
                {
                    "language":"de-DE",
                    "policyStatus":"optional",
                    "validation":"ready"
                },
                {
                    "language":"es-ES",
                    "policyStatus":"undefined",
                    "validation":"excluded"
                }
            ],
            "usedAssets":[
            ]
        },
        {
            "id":"structure",
            "name":"structure",
            "type":"structure",
            "publishable":false,
            "languages":[
                {
                    "language":"fr-FR",
                    "policyStatus":"required",
                    "validation":"missing"
                },
                {
                    "language":"de-DE",
                    "policyStatus":"optional",
                    "validation":"ready"
                },
                {
                    "language":"es-ES",
                    "policyStatus":"undefined",
                    "validation":"excluded"
                }
            ],
            "usedAssets":[
            ]
        },
        {
            "id":"10",
            "name":"Home",
            "type":"page",
            "publishable":false,
            "languages":[
                {
                    "language":"fr-FR",
                    "policyStatus":"required",
                    "validation":"missing"
                },
                {
                    "language":"de-DE",
                    "policyStatus":"optional",
                    "validation":"ready"
                },
                {
                    "language":"es-ES",
                    "policyStatus":"undefined",
                    "validation":"excluded"
                }
            ],
            "usedAssets":[
                {
                    "id":"CORED2FDC62C23504F6AB47B1F6106F9DC73",
                    "version":"draft"
                },
                {
                    "id":"CORE48AF98371AFC4568B260D4417E38A739",
                    "version":"published"
                },
                {
                    "id":"CONTBD592905665C4652BFEAE6FD19E9F291",
                    "version":"draft"
                },
                {
                    "id":"CONT9DE7B749A5E9438689492A0054C02707",
                    "version":"draft"
                }
            ]
        }
    ]
}

400レスポンス

不正なリクエスト

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

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

ネストされたスキーマ : 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"
    }
}

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

406レスポンス

受入れられない

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

レスポンスの例(無効なサイト・デフォルト言語)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Default Language",
    "status":"409",
    "detail":"Default Language '{defaultLanguage}' for site is not valid. The default language must be one of the localization policy's required languages.",
    "o:errorCode":"OCE-SITEMGMT-009075",
    "defaultLanguage":"en-US"
}

413 レスポンス

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

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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

先頭に戻る