機械翻訳について

サイトへの更新のコミット

post

/sites/management/api/v1/sites/{id}/updates/{updateId}/commit

EXTENDED OPERATION

ベース・サイトへの更新の変更をコミットします。 サイトがオンラインの場合、編集は公開操作後に公開されます。 そうしないと、サイトが公開(再)されてオンラインになった後で編集が公開されます。

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

認可

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

  • 所有者
  • マネージャ

サイトの公開

サイトの更新がコミットされると、変更はオンライン・サイトに公開されます。

詳細は、「サイトへの更新の公開」を参照してください。

パス代替識別子

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

nameサイト更新名

サイト更新識別子のかわりに、サイト更新名を使用して、リソース・パス内の更新を一意に識別できます。 サイト更新のデフォルトのリソース・パス・パラメータはサイト更新識別子ですが、サイト更新を操作すると、人間が読める更新名が使用しやすくなる場合があります。

http://api.example.com/sites/management/api/v1/sites/{id}/updates/name:MyEdits/commit

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

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

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

303他を参照 - 完全公開の強制

すべてのサイト・ファイルの完全公開を実行します。 デフォルトでは、パブリッシュは増分パブリッシュで、変更されたファイルのみがパブリッシュされます。

リクエスト

POST https://api.example.com/sites/management/api/v1/sites/{id}/updates/{updateId}/commit

リクエスト本文

{
  "doForceOverwrite": "true"
}

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

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(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.での導入。

404見つかりません - サイト更新が見つかりません

更新が存在しないか、削除されているか、認証されたユーザーまたはクライアント・アプリケーションが更新にアクセスできません。

エラー・コード

OCE-SITEMGMT-009122

解決 - 識別子のチェック

サイト識別子が有効であることを確認してください。

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

認証されたユーザーが関連サイトまたはサイト管理者のメンバーであることを確認します。

例外詳細フィールド

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

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

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

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

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

409競合 - サイト更新が見つかりません

以前に適用された更新の内容が衝突したため、ベース・サイトへの更新のマージに失敗しました。

エラー・コード

OCE-SITEMGMT-009127

例外詳細フィールド

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

フィールド名説明
updateベース・サイトへのマージに失敗した更新。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Update Not Found",
  "status": "409",
  "detail": "The merge of the update into the base site has failed due to a clash with content in a previously applied update.",
  "o:errorCode": "OCE-SITEMGMT-009127",
  "update": {
    "id": "FC274A0A4E18CD651C0EDD7DT0000DEFAULT00000000"
  }
}

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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
本文()

バージョン競合が発生したときに上書きを強制するかどうかなど、コミットを更新します。

ルート・スキーマ: schema
型: object
ソースを表示
  • 存在してtrueに設定されている場合、このオプションは、バージョンの競合の可能性に関係なく変更を強制的にコミットします。

    リリース21.9.1で導入されました。
  • links

    このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

例:
{
    "doForceOverwrite":"true"
}
ネストされたスキーマ: links
型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 「リンク」
トップに戻る

レスポンス

303レスポンス

他を参照
ヘッダー

400レスポンス

不正なリクエスト

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

404レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

    リリース21.9.1で導入されました。
ネストされたスキーマ: o:errorDetails
型: array

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

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

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

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

409レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

ネストされたスキーマ : BaseSiteAlreadyUpdatedExceptionDetail-allOf[1]
型: object
ソースを表示
  • ベース・サイトへのマージに失敗した更新。

    リリース21.9.1で導入されました。
ネストされたスキーマ: o:errorDetails
型: array

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

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

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

レスポンスの例(サイト更新が見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Update Not Found",
    "status":"409",
    "detail":"The merge of the update into the base site has failed due to a clash with content in a previously applied update.",
    "o:errorCode":"OCE-SITEMGMT-009127",
    "update":{
        "id":"FC274A0A4E18CD651C0EDD7DT0000DEFAULT00000000"
    }
}

413 レスポンス

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

415 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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