コンポーネントに対する更新の公開
/sites/management/api/v1/components/{id}/publish
サイト開発者によって行われた最新の更新を、そのコンポーネントを使用するサイトにコンポーネントで公開します。 サイトがオンラインの場合、公開操作が完了すると、更新はパブリック・アクセス可能になります。 サイトがオフラインの場合、サイトがアクティブ化され、オンラインで更新がパブリック・アクセス可能になるように更新が公開されます。
リリース19.4.1.での導入。
認可
この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:
- 所有者
- マネージャ
非同期処理
この操作では、「両方の」非同期および同期処理がサポートされます。 クライアントは、値respond-async
のPrefer
ヘッダーを追加することで、優先相互作用モードを指定できます。 サーバーは非同期リクエストを同期に変更できるため、両方のケースを処理するためにクライアントを準備する必要があります。 「承認済」レスポンスにはLocation
ヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。
ステータスの読取りの詳細は、「サイト関連ジョブの進捗の取得」を参照してください。
パス代替識別子
「コンポーネント」リソースのデフォルトの識別子は、「コンポーネント識別子」です。 コンポーネント・リソースは代替識別子をサポートします。
nameコンポーネント名
コンポーネント識別子のかわりに、コンポーネント名を使用してリソース・パスのコンポーネントを一意に識別できます。 コンポーネントのデフォルトのリソース・パス・パラメータはコンポーネント識別子ですが、コンポーネントを操作するときには、判読可能なコンポーネント名が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/components/name:FooterBar/publish
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
202確定済 - 名前で非同期で公開
FooterBarコンポーネントを非同期で公開します。 この例では、name
代替識別子を使用して、名前でコンポーネントを公開します。
リクエスト
POST https://api.example.com/sites/management/api/v1/components/name:FooterBar/publish
リクエスト・ヘッダー
Prefer=respond-async
リダイレクション・レスポンスの例
この操作は、次のリダイレクション(3xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。 ノート: この操作の起動に使用されるクライアント・テクノロジによっては、リダイレクトが自動的に実行される場合に2xxレスポンスが返されることがあります。
303See Other - Publish By Name
FooterBarコンポーネントを公開します。 この例では、name
代替識別子を使用して、名前でコンポーネントを公開します。
リクエスト
POST https://api.example.com/sites/management/api/v1/components/name:FooterBar/publish
クライアント・エラー・レスポンスの例
この操作は次のクライアント・エラー(4xx)レスポンスで応答しますが、レスポンス本文に例外の詳細が示されるか、非同期ジョブを通じてレポートされます。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
403Forbidden - Component Operation Forbidden
コンポーネント内で共有ロールを使用しても、この操作を実行できません。
エラー・コード
OCE-SITEMGMT-009055
解決 - 共有ロールの変更
認証ユーザーに指定されたロールを必要なロール以上に変更します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
component | 操作が実行されているコンポーネント。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのComponentOperationForbiddenExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Component Operation Forbidden", "status": "403", "detail": "You do have a sharing role in this component, but your role does not allow you to use this operation.", "o:errorCode": "OCE-SITEMGMT-009055", "component": { "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8" } }
リリース19.4.1.での導入。
403Forbidden - Storage Limit Reached
ストレージ転送制限に達しました。 請求限度は、システム管理者が使用可能なストレージ容量に設定されています。
エラー・コード
OCE-SITEMGMT-009098
解決 - ストレージ制限の増加
ストレージ制限を増やすシステム管理者を取得します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
used | 使用済ストレージ(GB)。 |
limit | ストレージ制限(GB)。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのStorageLimitReachedExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Storage Limit Reached", "status": "403", "detail": "Storage limit has been reached.", "o:errorCode": "OCE-SITEMGMT-009098", "used": 1.23456789, "limit": 1.23456789 }
リリース20.3.1で導入されました。
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 - Component Not Found
サイト・コンポーネントが存在しないか、削除されたか、認証済ユーザーまたはクライアント・アプリケーションがコンポーネントへのアクセス権を持っていません。
エラー・コード
OCE-SITEMGMT-009045
解決 - 識別子のチェック
コンポーネント識別子が有効であることを確認してください。
解決 - メンバーシップのチェック
認証されたユーザーがコンポーネントのメンバーであることを確認します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
component | 存在しないか、認証されたユーザーから見えないコンポーネントです。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのComponentNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Component Not Found", "status": "404", "detail": "Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.", "o:errorCode": "OCE-SITEMGMT-009045", "component": { "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8" } }
リリース19.4.1.での導入。
409Conflict - Component Deleted
ソフト削除されたコンポーネントでは操作を実行できません。 このエラーは、includeDeleted
問合せパラメータがtrue
に設定されている場合にのみ発生
エラー・コード
OCE-SITEMGMT-009060
解決 - コンポーネントのリストア
コンポーネントをリストアしてから操作を再試行してください。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
component | ソフト削除されたコンポーネント。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのComponentDeletedExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Component Deleted", "status": "409", "detail": "The operation cannot be performed as the component has been soft deleted.", "o:errorCode": "OCE-SITEMGMT-009060", "component": { "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8" } }
リリース19.4.1.での導入。
リクエスト
- id: string
コンポーネントの不変の識別子。
- includeDeleted(optional): boolean
削除対象としてマークされているリソースでは、この問合せパラメータが
true
に設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。includeDeleted
問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。
- Prefer(optional): string
respond-async
ヘッダー値を使用してリクエストの非同期処理をリクエストします。
レスポンス
202レスポンス
303レスポンス
400レスポンス
401レスポンス
403レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ComponentOperationForbiddenExceptionDetail-allOf[1]
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ページなどの問題の判読可能なサマリーを提供します。
object
- component(オプション): string
操作が実行されているコンポーネント。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Component Operation Forbidden",
"status":"403",
"detail":"You do have a sharing role in this component, but your role does not allow you to use this operation.",
"o:errorCode":"OCE-SITEMGMT-009055",
"component":{
"id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
}
}
{
"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レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ComponentNotFoundExceptionDetail-allOf[1]
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ページなどの問題の判読可能なサマリーを提供します。
object
- component(オプション): string
存在しないか、認証されたユーザーから見えないコンポーネントです。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Component Not Found",
"status":"404",
"detail":"Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.",
"o:errorCode":"OCE-SITEMGMT-009045",
"component":{
"id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
}
}
409レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object ComponentDeletedExceptionDetail-allOf[1]
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ページなどの問題の判読可能なサマリーを提供します。
object
- component(オプション): string
ソフト削除されたコンポーネント。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Component Deleted",
"status":"409",
"detail":"The operation cannot be performed as the component has been soft deleted.",
"o:errorCode":"OCE-SITEMGMT-009060",
"component":{
"id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
}
}