機械翻訳について

サイトのアクティブ化

post

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

EXTENDED OPERATION

サイトをオンラインにします。 サイトをアクティブ化するには、サイトが「オフライン」およびpublishedである必要があります。

認可

サイト・ガバナンスが有効な場合、「サイト管理者」は任意のサイトをアクティブ化できます。 サイトと共有され、次のいずれかの「共有」ロールを持つユーザーは、サイトをアクティブ化することもできます:

  • 所有者
  • マネージャ

期限切れサイトのアクティブ化

失効したサイトをアクティブ化できません。 サイトが期限切れで、サイトをオンライン化する必要がある場合、サイトの有効期限はサイト・マネージャまで延長できます。

詳細は、「サイトの有効期限の延長」を参照してください。

パス代替識別子

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

nameサイト名

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

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

リリース19.4.1.での導入。

リダイレクション・レスポンスの例

この操作は、次のリダイレクション(3xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。 ノート: この操作の起動に使用されるクライアント・テクノロジによっては、リダイレクトが自動的に実行される場合に2xxレスポンスが返されることがあります。

303See Other - Successful Activation

サイトが正常にアクティブ化されたときに他のレスポンス・ステータス・コードが返され、Locationヘッダーにアクティブ化されたサイト・リソースのロケーションが含まれています。

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

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

400Bad Request - Invalid Site Security Access

サイトのセキュリティ・ポリシーは、指定されたセキュリティ・アクセス・レベルを持つことができないことを意味します。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。 たとえば、セキュリティ・ポリシー内のサイトのセキュリティ・レベルがサービス・ユーザーを指定している場合、セキュリティ・アクセスはすべてのクラウド・ユーザーになることはできません。 サイトのセキュリティ・アクセス・レベルが許可されていない場合、サイトを公開したりサイト・アクセス・メンバーを更新することはできません。

エラー・コード

OCE-SITEMGMT-009019

解決 - セキュリティ・アクセスの変更

サイトのセキュリティ・ポリシーに準拠するようにサイトのセキュリティ・アクセス・レベルを変更し、操作を再試行してください。 サイト・ガバナンスが有効になっている場合、サイトが作成されたサイト・テンプレートのセキュリティ・ポリシーによって最初に定義されている、サイトごとのセキュリティ・ポリシーを指定できます。 サイト・ガバナンスが有効になる前に作成されたサイトには、サイトのセキュリティ・ポリシーがないため、テナント・サービス・レベル・ポリシーにフォールバックします。 このエラーが発生した場合は、そのサイトで直接セキュリティ・ポリシーを「パブリック」に設定できます。

例外詳細フィールド

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

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

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Security Access",
  "status": "400",
  "detail": "Site security access levels are not allowed by the security policy.",
  "o:errorCode": "OCE-SITEMGMT-009019",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

403Forbidden - Site Operation Forbidden

サイト内で共有ロールを持つユーザーは、この操作を実行できません。

エラー・コード

OCE-SITEMGMT-009026

解決 - 共有ロールの変更

認証ユーザーに付与された共有ロールを必要なロール以上に変更します。

解決 - アプリケーション・ロールの変更

ユーザーにStandardユーザーまたはエンタープライズ・ユーザー・アプリケーション・ロールがあることを確認します。

例外詳細フィールド

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

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

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Operation Forbidden",
  "status": "403",
  "detail": "You do have a sharing role in this site, but your role does not allow you to use this operation.",
  "o:errorCode": "OCE-SITEMGMT-009026",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

リリース19.1.5.での導入。

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

403Forbidden - Outbound Data Limit Reached

アウトバウンド・データ制限に達しました。 システム管理者によってアウトバウンド・データの量に制限が設定されました。

エラー・コード

OCE-SITEMGMT-009100

解決 - アウトバウンド・データ制限の増加

アウトバウンド・データ制限を増やすシステム管理者を取得します。

例外詳細フィールド

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

フィールド名説明
used使用されるアウトバウンド・データ(GB)。
limitアウトバウンド・データ制限(GB)。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Outbound Data Limit Reached",
  "status": "403",
  "detail": "Outbound data limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009100",
  "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 - Invalid Site Status

サイトが間違った状態にあるため、サイト操作を実行できません。 すでにオンラインになっているサイトをオンラインにしたり、オンラインサイトの名前を変更したりする例。

エラー・コード

OCE-SITEMGMT-009013

解決 - セキュリティ・レベルを更新する前にサイトをオフラインにします

サイトがオンラインである間は、サイトのセキュリティ・レベルをパブリックからセキュア・サイトに変更したり、またはその逆に変更したりすることはできません。 サイトにサインインが必要かどうかを変更するために、サイトをオフラインおよび非公開にする必要があるかどうか。

解決 - 名前変更前にサイトをオフラインにします

サイトの名前を変更するには、オフラインで未公開である必要があります。

例外詳細フィールド

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

フィールド名説明
site操作が実行されているサイト。
runtimeStatusサイト 有効な値は次のとおりです。
  • offline - サイトはオフラインです。 サイトがアクティブ化されていないか、アクティブ化されて非アクティブ化されています
  • online - サイトはオンラインです。 サイトがアクティブ化されました
requiredStatus必須サイト・ステータスです。 有効な値は次のとおりです。
  • offline - サイトはオフラインです。 サイトがアクティブ化されていないか、アクティブ化されて非アクティブ化されています
  • online - サイトはオンラインです。 サイトがアクティブ化されました

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Status",
  "status": "409",
  "detail": "Operation cannot be performed on a site with status '{runtimeStatus}'.",
  "o:errorCode": "OCE-SITEMGMT-009013",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "runtimeStatus": "offline",
  "requiredStatus": "offline"
}

409Conflict - Invalid Site Publish Status

サイトが間違った公開状態にあるため、サイト操作を実行できません。 例として、未公開のサイトをオンラインにするか、公開済サイトの名前を変更しようとしています。

エラー・コード

OCE-SITEMGMT-009031

解決 - セキュリティ・レベル更新前のサイトの公開解除

サイトが公開されている間は、サイト・セキュリティ・レベルをパブリックからセキュア・サイトに変更したり、またはその逆に変更することはできません。 サイトにサインインが必要かどうかを変更するために、サイトをオフラインおよび非公開にする必要があるかどうか。

解決 - 名前変更前のサイトの公開取消

サイトの名前を変更するには、オフラインで未公開である必要があります。

例外詳細フィールド

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

フィールド名説明
site操作が実行されているサイト。
publishStatusサイト公開ステータス。 有効な値は次のとおりです。
  • unpublished - サイトは公開されていません。 ランタイム・サイト環境に公開されたファイルがありません
  • draft - サイトに下書き更新があります。 公開されたファイルがランタイム・サイト環境に存在しますが、ベース・サイトに新しい未承認の更新があります
  • approved - サイトには更新が承認されました。 公開されたファイルはランタイム・サイト環境に存在しますが、ベース・サイトには新しい承認済の更新があります
  • published - サイトは公開されています。 公開されたファイルは、ランタイム・サイト環境に存在
requiredStatus必須のサイト・パブリッシュ・ステータス。 有効な値は次のとおりです。
  • unpublished - サイトは公開されていません。 ランタイム・サイト環境に公開されたファイルがありません
  • draft - サイトに下書き更新があります。 公開されたファイルがランタイム・サイト環境に存在しますが、ベース・サイトに新しい未承認の更新があります
  • approved - サイトには更新が承認されました。 公開されたファイルはランタイム・サイト環境に存在しますが、ベース・サイトには新しい承認済の更新があります
  • published - サイトは公開されています。 公開されたファイルは、ランタイム・サイト環境に存在

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Publish Status",
  "status": "409",
  "detail": "Operation cannot be performed on a site with publish status '{publishStatus}'.",
  "o:errorCode": "OCE-SITEMGMT-009031",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "publishStatus": "unpublished",
  "requiredStatus": [
      "unpublished"
  ]
}

409Conflict - Site Deleted

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

エラー・コード

OCE-SITEMGMT-009059

解決 - サイトのリストア

サイトをリストアしてから操作を再試行してください。

例外詳細フィールド

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

フィールド名説明
siteサイト識別子が指定されている場合、ソフト削除されるサイト。

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

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

リリース19.4.1.での導入。

409Conflict - Site Expired

サイトが失効しているため、操作を実行できません。 たとえば、サイトが失効している場合、サイトをオンラインにすることはできません。

エラー・コード

OCE-SITEMGMT-009069

解決 - サイトの有効期限の延長

サイトの有効期限を延長し、操作を再試行してください。

例外詳細フィールド

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

フィールド名説明
site失効したサイト。
expiration有効期限 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Expired",
  "status": "409",
  "detail": "Operation cannot be performed as the site has expired.",
  "o:errorCode": "OCE-SITEMGMT-009069",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "expiration": "2019-06-01T06:44:17.000Z"
}

リリース19.4.1.での導入。

409競合 - サイトのアクティブ化はすでに進行中です

サイトの公開/アクティブ化が現在アクティブ化されている間はリクエストできません。

エラー・コード

OCE-SITEMGMT-009165

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Activation Already In Progress",
  "status": "409",
  "detail": "Unable to request site publish/activation while it is currently being activated.",
  "o:errorCode": "OCE-SITEMGMT-009165"
}

409競合 - サイト更新進行中

サイトの更新中は、サイトの公開/アクティブ化をリクエストできません。

エラー・コード

OCE-SITEMGMT-009174

例外詳細フィールド

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

フィールド名説明
site操作が進行中のサイト。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Update In Progress",
  "status": "409",
  "detail": "Unable to request site publish/activation while it is currently being updated.",
  "o:errorCode": "OCE-SITEMGMT-009174",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

409競合 - サイト静的公開進行中

現在静的公開中は、サイトの公開/アクティブ化をリクエストできません。

エラー・コード

OCE-SITEMGMT-009175

例外詳細フィールド

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

フィールド名説明
site操作が進行中のサイト。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Static Publish In Progress",
  "status": "409",
  "detail": "Unable to request site publish/activation while it has a static publish in progress.",
  "o:errorCode": "OCE-SITEMGMT-009175",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

リクエスト

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

トップに戻る

レスポンス

303レスポンス

他を参照
ヘッダー

400レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

レスポンスの例(無効なサイト・セキュリティ・アクセス)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Security Access",
    "status":"400",
    "detail":"Site security access levels are not allowed by the security policy.",
    "o:errorCode":"OCE-SITEMGMT-009019",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

401レスポンス

未認可

403レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

レスポンスの例(サイト操作禁止)
{
    "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":"Storage Limit Reached",
    "status":"403",
    "detail":"Storage limit has been reached.",
    "o:errorCode":"OCE-SITEMGMT-009098",
    "used":1.23456789,
    "limit":1.23456789
}
レスポンスの例(アウトバウンド・データ制限に達しました)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Outbound Data Limit Reached",
    "status":"403",
    "detail":"Outbound data limit has been reached.",
    "o:errorCode":"OCE-SITEMGMT-009100",
    "used":1.23456789,
    "limit":1.23456789
}

404レスポンス

見つかりません
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : SiteNotFoundExceptionDetail
すべてに一致
ソースを表示
  • ExceptionDetail

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

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

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

409レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

ネストされたスキーマ : InvalidSiteRuntimeStatusExceptionDetail-allOf[1]
型: object
ソースを表示
  • 必須サイト・ステータスです。

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

    • offline - サイトはオフラインです。 サイトがアクティブ化されていないか、アクティブ化されて非アクティブ化されています
    • online - サイトはオンラインです。 サイトがアクティブ化されました

  • サイト

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

    • offline - サイトはオフラインです。 サイトがアクティブ化されていないか、アクティブ化されて非アクティブ化されています
    • online - サイトはオンラインです。 サイトがアクティブ化されました

  • 操作が実行されているサイト。

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

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

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

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

レスポンスの例(無効なサイト・ステータス)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Status",
    "status":"409",
    "detail":"Operation cannot be performed on a site with status '{runtimeStatus}'.",
    "o:errorCode":"OCE-SITEMGMT-009013",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "runtimeStatus":"offline",
    "requiredStatus":"offline"
}
レスポンスの例 (無効なサイト・パブリッシュ・ステータス)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Publish Status",
    "status":"409",
    "detail":"Operation cannot be performed on a site with publish status '{publishStatus}'.",
    "o:errorCode":"OCE-SITEMGMT-009031",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "publishStatus":"unpublished",
    "requiredStatus":[
        "unpublished"
    ]
}
レスポンスの例(サイト削除)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the site has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009059",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}
レスポンスの例(サイトの期限切れ)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Expired",
    "status":"409",
    "detail":"Operation cannot be performed as the site has expired.",
    "o:errorCode":"OCE-SITEMGMT-009069",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "expiration":"2019-06-01T06:44:17.000Z"
}
レスポンスの例(サイトのアクティブ化はすでに進行中)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Activation Already In Progress",
    "status":"409",
    "detail":"Unable to request site publish/activation while it is currently being activated.",
    "o:errorCode":"OCE-SITEMGMT-009165"
}
レスポンスの例(サイト更新が進行中)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Update In Progress",
    "status":"409",
    "detail":"Unable to request site publish/activation while it is currently being updated.",
    "o:errorCode":"OCE-SITEMGMT-009174",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}
レスポンスの例(サイト静的パブリッシュが進行中)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Static Publish In Progress",
    "status":"409",
    "detail":"Unable to request site publish/activation while it has a static publish in progress.",
    "o:errorCode":"OCE-SITEMGMT-009175",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

413 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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