機械翻訳について

削除したコンポーネントの削除を元に戻す

post

/sites/management/api/v1/components/{id}/undelete

EXTENDED OPERATION

コンポーネントのソフト削除を元に戻します。 フォルダがソフト削除される前に、関連したコンポーネント・フォルダをごみ箱から元のロケーションに移動して、コンポーネントをリストアします。

リリース19.4.1.での導入。

認可

コンポーネントは、コンポーネントの所有者またはコンポーネントをソフト削除したユーザーによってリストアできます。

パス代替識別子

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

nameコンポーネント名

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

http://api.example.com/sites/management/api/v1/components/name:FooterBar/undelete

リリース19.4.1.での導入。

成功したレスポンスの例

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

201Created - Restore a Component By Name

FooterBarと呼ばれるソフト削除されたコンポーネントをリストアします。

リクエスト

POST https://api.example.com/sites/management/api/v1/components/name:FooterBar/undelete
リリース20.1.1で導入されました。

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

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

404Not Found - Component Name Ambiguous

指定された名前ではコンポーネントが一意に識別されません。 削除されたコンポーネントが名前によって参照され、同じ名前のコンポーネントが複数削除された場合、このエラーが発生します。 このエラーには、削除されたコンポーネントの詳細が同じ名前で表示されます。

エラー・コード

OCE-SITEMGMT-009089

解決 - コンポーネント識別子の使用

名前のかわりに一意のコンポーネント識別子を使用して、コンポーネントを識別します。

例外詳細フィールド

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

フィールド名説明
component存在しないか、認証されたユーザーから見えないコンポーネントです。
components名前が一致するコンポーネント。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Name Ambiguous",
  "status": "404",
  "detail": "Multiple components exist with an identifier of '{component.id}'.",
  "o:errorCode": "OCE-SITEMGMT-009089",
  "component": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  },
  "components": [
      {
        "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
        "name": "ContentNavMenu",
        "isDeleted": false,
        "description": "A folder for my assets.",
        "createdAt": "2019-06-01T06:44:17.000Z",
        "lastModifiedAt": "2019-06-01T06:44:17.000Z",
        "type": "unknown",
        "category": "value",
        "publishStatus": "unpublished",
        "isHidden": false,
        "logo": "value"
      }
  ]
}

リリース20.1.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 Not Deleted

コンポーネントがソフト削除されていないため、操作を実行できません。

エラー・コード

OCE-SITEMGMT-009064

例外詳細フィールド

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

フィールド名説明
componentソフト削除されていないコンポーネント。

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

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

リリース19.4.1.での導入。

リクエスト

パス・パラメータ
トップに戻る

レスポンス

201レスポンス

作成日
ヘッダー

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 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"
    }
}

404レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

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

名前が一致するコンポーネント。

リリース20.1.1で導入されました。
ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • Component

    コンポーネントは、Webページの個々の部分です。 Webページを参照すると、何が表示されますか。 おそらく、いくつかのタイトル、テキストの段落、およびサイトの他のページへのリンクが表示されているでしょう。 イメージ、ボタン、区切り、マップおよびギャラリが表示されることもあります。 これらの各アイテムがコンポーネントです。

    リリース19.4.1.での導入。
ネストされたスキーマ : コンポーネント

コンポーネントは、Webページの個々の部分です。 Webページを参照すると、何が表示されますか。 おそらく、いくつかのタイトル、テキストの段落、およびサイトの他のページへのリンクが表示されているでしょう。 イメージ、ボタン、区切り、マップおよびギャラリが表示されることもあります。 これらの各アイテムがコンポーネントです。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

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

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示
  • links
ネストされたスキーマ : Component-allOf[1]
型: object
ソースを表示
  • コンポーネント・カテゴリ。

    リリース19.4.1.での導入。
  • 作成日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

    リリース19.4.1.での導入。
  • createdBy

    このコンポーネントを作成したユーザーまたはクライアント・アプリケーション。

    リリース19.4.1.での導入。
  • 最大長: 1000

    オプションの説明。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

    リリース19.4.1.での導入。
  • コンポーネントの不変の識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.4.1.での導入。
  • コンポーネントがソフト削除されたことを示します。 対応するコンポーネント・フォルダは、コンポーネントを所有しているユーザーのごみ箱フォルダに入っています。

    リリース19.4.1.での導入。
  • サイト・エディタでカスタム・パレットからコンポーネントを非表示にします。

    リリース19.4.1.での導入。
  • 最終変更日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

    リリース19.4.1.での導入。
  • lastModifiedBy

    このコンポーネントを最後に変更したユーザー、クライアント・アプリケーションまたはサービス。

    リリース19.4.1.での導入。
  • コンポーネント・ロゴに使用されるイメージの名前。

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

    コンポーネントを共有しているユーザーおよびグループ。

    リリース19.4.3での導入。
  • 最大長: 255

    コンポーネントの読取り可能な名前。

    リリース19.4.1.での導入。
  • ownedBy

    このコンポーネントを所有するユーザーまたはクライアント・アプリケーション。

    リリース19.4.1.での導入。
  • permissions

    コンポーネントのユーザー権限。

    リリース22.7.2で導入されました。
  • コンポーネントが公開されているかどうかを示します。

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

    • unpublished - コンポーネントは公開されていません
    • published - コンポーネントは公開されています

    リリース19.4.1.での導入。
  • コンポーネント・タイプ。

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

    • unknown - 不明なコンポーネント・タイプ
    • componentGroup - コンポーネント・グループ
    • contentLayout - コンテンツ・レイアウト
    • contentForm - コンテンツ・フォーム
    • fieldEditor - フィールド・エディタ
    • sectionLayout - セクション・レイアウト
    • remote - リモート・コンポーネント
    • local - ローカル・コンポーネント
    • sandboxed - サンドボックス化されたiFrameのローカル・コンポーネント
    • visualBuilder - Visual Builder Cloud Service (VBCS)コンポーネント
    • translationEditor - 翻訳ジョブ・エディタ
    • customFilterPanel - カスタム・フィルタ・パネル
    • template - テンプレート・コンポーネント
    • rssTemplate - RSSテンプレート・コンポーネント

    リリース19.4.1.での導入。
ネストされたスキーマ : createdBy

このコンポーネントを作成したユーザーまたはクライアント・アプリケーション。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : lastModifiedBy

このコンポーネントを最後に変更したユーザー、クライアント・アプリケーションまたはサービス。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ: members
型: object

コンポーネントを共有しているユーザーおよびグループ。

リリース19.4.3での導入。
ソースを表示
  • items

    「コンポーネント・メンバー」要素のコレクション。

    リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • CollectionResource

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

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

このコンポーネントを所有するユーザーまたはクライアント・アプリケーション。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : 許可
型: object

コンポーネントのユーザー権限。

リリース22.7.2で導入されました。
ソースを表示
  • annotation

    ユーザーが持つ注釈権限のセット。

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

    • read - 注釈を読む
    • write - 注釈の作成
    • update - 注釈の更新
    • delete - 注釈の削除

    リリース22.7.2で導入されました。
  • conversation

    ユーザーが持つ会話権限のセット。

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

    • read - 会話を読む
    • write - 会話への書込み
    • update - 会話の更新
    • delete - 会話の削除

    リリース22.7.2で導入されました。
  • file

    ユーザーが持つファイル・レベルのアクセス権のセット。

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

    • preview - ファイルのプレビュー
    • read - ファイルの読取り
    • write - ファイルへの書込み
    • update - 更新ファイル
    • delete - ファイルの削除

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

    ユーザーが持つメンバーの権限セット。

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

    • read - メンバーの読み取りと一覧表示
    • add - メンバーに追加
    • update - メンバーの更新
    • remove - メンバーの削除

    リリース22.7.2で導入されました。
  • self

    ユーザーが持つフォルダ・レベルの権限のセット。

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

    • preview - フォルダのプレビュー
    • read - フォルダの読取り
    • write - フォルダへの書込み
    • update - フォルダの更新
    • delete - フォルダ

    リリース22.7.2で導入されました。
  • shareLink
ネストされたスキーマ: Identity
識別子: type

ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

リリース20.3.1で導入されました。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Identity-allOf[1]
ネストされたスキーマ : Identity-allOf[1]
型: object
ソースを表示
  • 人間が判読できる表示名。

    リリース20.3.1で導入されました。
  • ユーザーまたはクライアント・アプリケーションに対してCECによって割り当てられる識別子値。 識別子はサービスのスコープ内で一意です。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース20.3.1で導入されました。
  • ユーザー名やクライアント・アプリケーション名などの一意の名前。

    リリース20.3.1で導入されました。
  • roles

    ロール

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

    • CECServiceAdministrator - サービス管理者
    • ユーザー列挙の割当
    • ユーザーのパスワードおよびチャレンジ質問の変更
    • サービス・インスタンスの構成、モニターおよび管理
    • CECSitesAdministrator - サイト管理者
    • サイト、テンプレート、テーマまたはコンポーネントの作成
    • CECRepositoryAdministrator - リポジトリ管理者
    • CECDeveloperUser - 開発者ユーザー
    • CECContentAdministrator - コンテンツ管理者
    • 新規コンテンツ・タイプの作成およびアイテムの公開
    • CECStandardUser - 標準ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • サイト内のコンテンツの表示および操作
    • カスタム・プロパティの管理と表示、および値の編集
    • CECEnterpriseUser - エンタープライズ・ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • デジタル・アセット
    • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
    • コンテンツ・アイテムの作成、管理、表示および操作
    • コレクション
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • カスタム・プロパティの管理と表示、および値の編集
    • CECExternalUser - 外部ユーザー
    将来使用するために予約済
    • CECIntegrationUser - 統合ユーザー
    Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
    • CECSitesVisitor - サイト・ビジター
    サイトへのアクセスはビジターに制限されます。

    リリース21.10.2で導入されました。
  • 「アイデンティティ」のタイプ。 有効な値は次のとおりです: user, service, application, unknown

    リリース20.3.1で導入されました。
ネストされたスキーマ: roles
型: array

ロール

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

  • CECServiceAdministrator - サービス管理者
  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者
  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者
  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー
将来使用するために予約済
  • CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
  • CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。

リリース21.10.2で導入されました。
ソースを表示
ネストされたスキーマ: items
型: array

「コンポーネント・メンバー」要素のコレクション。

リリース19.4.1.での導入。
ソースを表示
ネストされたスキーマ : CollectionResource

REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • CollectionResource-allOf[1]
ネストされたスキーマ : CollectionResource-allOf[1]
型: object
ソースを表示
  • レスポンス内のリソースの合計数。

  • コレクションには、リクエストに一致する多くの要素があります。 ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。

  • 実際のレスポンス・サイズ制限。 リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。

  • 使用される実際のレスポンス・オフセット。 リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。

  • リクエストに一致するリソースの合計数。 指定した場合は、使用可能なアイテムの合計数です。 指定されない場合、合計が不明か、または戻り不可能です。 この値を計算するとき、ページング制限またはオフセットは無視されます。 totalResultsパラメータがサポートされていて、クライアントがtrueに設定している場合にのみ返されます。

ネストされたスキーマ: items
型: object
ソースを表示
  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

    リリース19.4.1.での導入。
  • グループ

    メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

    リリース19.4.1.での導入。
  • メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。

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

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース20.1.1で導入されました。
  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.4.1.での導入。
  • 関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。

    リリース21.10.2で導入されました。
  • ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。

    リリース19.4.1.での導入。
  • ユーザー、クライアント・アプリケーションまたはグループが与えられた共有ロール。

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

    • owner - ユーザーが所有者です。
    • manager - ユーザーにマネージャ・ロールがあります
    • contributor - ユーザーにコントリビュータ・ロールがあります
    • downloader - ユーザーにはダウンロード実行者ロールがあります
    • viewer - ユーザーの参照者のロール

    リリース19.4.1.での導入。
  • メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。

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

    • user - メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
    クライアント・アプリケーションであるメンバー。
    • group - メンバーはグループです

    リリース19.4.1.での導入。
  • user

    メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

    リリース19.4.1.での導入。
ネストされたスキーマ : グループ

メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • Group

    グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

    リリース19.3.1.での導入。
ネストされたスキーマ: user

メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ: Group

グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

リリース19.3.1.での導入。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Group-allOf[1]
ネストされたスキーマ : Group-allOf[1]
型: object
ソースを表示
  • グループに対する、人間が読み取り可能な名前。

    リリース19.3.1.での導入。
  • サービス・インスタンス内で一意のグループ名。

    リリース19.3.1.での導入。
  • グループの一意の識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.3.1.での導入。
  • roles

    ロール

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

    • CECServiceAdministrator - サービス管理者
    • ユーザー列挙の割当
    • ユーザーのパスワードおよびチャレンジ質問の変更
    • サービス・インスタンスの構成、モニターおよび管理
    • CECSitesAdministrator - サイト管理者
    • サイト、テンプレート、テーマまたはコンポーネントの作成
    • CECRepositoryAdministrator - リポジトリ管理者
    • CECDeveloperUser - 開発者ユーザー
    • CECContentAdministrator - コンテンツ管理者
    • 新規コンテンツ・タイプの作成およびアイテムの公開
    • CECStandardUser - 標準ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • サイト内のコンテンツの表示および操作
    • カスタム・プロパティの管理と表示、および値の編集
    • CECEnterpriseUser - エンタープライズ・ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • デジタル・アセット
    • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
    • コンテンツ・アイテムの作成、管理、表示および操作
    • コレクション
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • カスタム・プロパティの管理と表示、および値の編集
    • CECExternalUser - 外部ユーザー
    将来使用するために予約済
    • CECIntegrationUser - 統合ユーザー
    Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
    • CECSitesVisitor - サイト・ビジター
    サイトへのアクセスはビジターに制限されます。

    リリース21.10.2で導入されました。
  • グループのタイプ。

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

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース19.3.1.での導入。
ネストされたスキーマ: roles
型: array

ロール

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

  • CECServiceAdministrator - サービス管理者
  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者
  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者
  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー
将来使用するために予約済
  • CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
  • CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。

リリース21.10.2で導入されました。
ソースを表示
ネストされたスキーマ : 注釈
型: array

ユーザーが持つ注釈権限のセット。

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

  • read - 注釈を読む
  • write - 注釈の作成
  • update - 注釈の更新
  • delete - 注釈の削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ : 会話
型: array

ユーザーが持つ会話権限のセット。

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

  • read - 会話を読む
  • write - 会話への書込み
  • update - 会話の更新
  • delete - 会話の削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ : file
型: array

ユーザーが持つファイル・レベルのアクセス権のセット。

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

  • preview - ファイルのプレビュー
  • read - ファイルの読取り
  • write - ファイルへの書込み
  • update - 更新ファイル
  • delete - ファイルの削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ: members
型: array

ユーザーが持つメンバーの権限セット。

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

  • read - メンバーの読み取りと一覧表示
  • add - メンバーに追加
  • update - メンバーの更新
  • remove - メンバーの削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ: self
型: array

ユーザーが持つフォルダ・レベルの権限のセット。

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

  • preview - フォルダのプレビュー
  • read - フォルダの読取り
  • write - フォルダへの書込み
  • update - フォルダの更新
  • delete - フォルダ

リリース22.7.2で導入されました。
ソースを表示
レスポンスの例(コンポーネント名のあいまいさ)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Name Ambiguous",
    "status":"404",
    "detail":"Multiple components exist with an identifier of '{component.id}'.",
    "o:errorCode":"OCE-SITEMGMT-009089",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    },
    "components":[
        {
            "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
            "name":"ContentNavMenu",
            "isDeleted":false,
            "description":"A folder for my assets.",
            "createdAt":"2019-06-01T06:44:17.000Z",
            "lastModifiedAt":"2019-06-01T06:44:17.000Z",
            "type":"unknown",
            "category":"value",
            "publishStatus":"unpublished",
            "isHidden":false,
            "logo":"value"
        }
    ]
}
レスポンスの例(コンポーネントが見つかりません)
{
    "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レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

レスポンスの例(コンポーネントが削除されていない)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Not Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the component has not been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009064",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    }
}

413 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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