機械翻訳について
  1. サイト管理用のREST API
  2. タスク
  3. コンポーネント
  4. インポートとエクスポート

コンポーネントのインポート

post

/sites/management/api/v1/components

COLLECTION

Zipファイルからコンポーネントをインポートします。 Zipファイルには、コンポーネントの詳細と構造が格納されます。 Zipファイルは、最初に認証済ユーザーの個人フォルダにアップロードする必要があります。 このインポート用のzipファイルは、リクエスト本文フィールドの一部として指定する必要があります。 コンポーネントはすでに存在している可能性があるため、このコンポーネントのインポートを回避する競合があり、競合解消が指定されていない場合には、「コンポーネント・インポートの競合」レスポンスが受信されます。 このレスポンスには、すべての競合に関する詳細が含まれています。 競合解決の詳細は、既存のコンポーネントの上書きなど、リクエスト本文のフィールドに指定できます。 競合解決が指定されている場合、指定された解決を使用して競合の解決が試行されるか、解決が不可能な場合はエラーが表示されます。 競合解決処理の例としては、ターゲット・リソースの上書きや、新しいアイデンティティでのリソースの作成などがあります。

リリース19.4.1.での導入。

認可

この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションに、リストされたロールのいずれかが必要です。 ただし、サービス管理者がコンポーネントの作成をサイト管理者に制限している場合は、サイト管理者のみがコンポーネントを作成できます。

  • CECDeveloperUser
  • CECContentAdministrator
  • CECSitesAdministrator

コンポーネントのエクスポート

コンポーネント・パッケージは、コンポーネント・フォルダを圧縮することで、または既存のコンポーネントをエクスポートすることで、手動で作成できます。

詳細は、「コンポーネントのエクスポート」を参照してください。

リクエスト本文の代替識別子

リクエスト本文は、代替識別子をサポートするリソースを参照します。 これらの代替識別子は、デフォルトのリソース識別子を使用する代わりに使用できます。

pathファイル・パス

「ドキュメント・ファイル」リソースのデフォルトの識別子は、Idです。

ファイル識別子の代わりに、ファイル・パスを使用してファイルを識別できます。 パスは、親フォルダの名前(ユーザー・ホーム・フォルダに対して相対的に)とファイル名(/で結合)を使用して構築されます。 ファイル・パスは個人フォルダにのみ使用できます。共有フォルダ内のファイルはパスで参照できません。 フォルダ名とファイル名は大文字と小文字が区別されません。

path:folder1/folder2/file.ext

リリース19.4.3での導入。

成功したレスポンスの例

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

201Created - Import with no Conflict Resolution

競合解決のないコンポーネントをインポートします。 リクエストに競合解消が指定されていないため、コンポーネントのアイデンティティまたは名前を変更せずにインポートが試行されます。 既存のコンポーネントと競合する場合は、「コンポーネント・インポートの競合」レスポンスが受信されます。

リクエスト

POST https://api.example.com/sites/management/api/v1/components

リクエスト本文

{
  "file": "path:packages/components/component.zip"
}

201作成日 - 既存のコンポーネントの上書き

コンポーネントをシステムにインポートし、同じアイデンティティを持つすでに存在するコンポーネントを上書きします。

リクエスト

POST https://api.example.com/sites/management/api/v1/components

リクエスト本文

{
  "file": "path:packages/components/component.zip",
  "conflicts": {
    "resolution": "overwrite"
  }
}

201作成日 - 競合時にインポートをスキップ

コンポーネントをシステムにインポートしますが、競合がある場合はインポートをスキップし、既存のコンポーネントはそのままにします。

リクエスト

POST https://api.example.com/sites/management/api/v1/components

リクエスト本文

{
  "file": "path:packages/components/component.zip",
  "conflicts": {
    "resolution": "skip"
  }
}

201作成日 - コンポーネント名の変更

潜在的な名前の競合を回避するために、新しい名前を持つコンポーネントをインポートします。

リクエスト

POST https://api.example.com/sites/management/api/v1/components

リクエスト本文

{
  "file": "path:packages/components/component.zip",
  "conflicts": {
    "resolution": "rename",
    "name": "AnotherNavMenu"
  }
}

201作成日 - ファイル識別子でインポート

競合を解決せずにコンポーネント・パッケージをインポートし、パスではなくファイル識別子を使用してファイルを識別します。

リクエスト

POST https://api.example.com/sites/management/api/v1/components

リクエスト本文

{
  "file": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
}

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

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

303See Other - Component Overwritten or Skipped

既存のコンポーネントが作成された場合、レスポンスはコンポーネントが作成されたことを示し、Locationヘッダーには新しく作成されたコンポーネントのロケーションが含まれます

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

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

400Bad Request - Invalid File

識別子で識別されるファイルが見つかりません。

エラー・コード

OCE-DOCS-001002

解決 - ファイルが存在するか確認

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

解決 - 親フォルダでのロールの共有の確認

認証されたユーザーが、ファイルを含むフォルダ内にロールを持っていることを確認します。

例外詳細フィールド

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

フィールド名説明
file存在しないファイル。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid File",
  "status": "400",
  "detail": "File does not exist or the authenticated user or client application does not have access to the file.",
  "o:errorCode": "OCE-DOCS-001002",
  "file": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  }
}

リリース19.4.1.での導入。

400不正なリクエスト - 無効なインポート・ファイル

インポート・ファイルが無効です。

エラー・コード

OCE-SITEMGMT-009145

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Import File",
  "status": "400",
  "detail": "Invalid import file.",
  "o:errorCode": "OCE-SITEMGMT-009145"
}

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

403Forbidden - Component Overwrite Denied

overwriteの競合解消でコンポーネントをインポートする場合、そのコンポーネントはすでに存在しますが、認証されたユーザーには上書きする権限がありません。

エラー・コード

OCE-SITEMGMT-009050

解決 - コンポーネントの共有

所有者は、ユーザーがコンポーネントを上書きできるように、コンポーネントのmanagerとしてユーザーを追加できます。

例外詳細フィールド

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

フィールド名説明
nameコンポーネント名
ownerコンポーネント所有者担当者詳細。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Overwrite Denied",
  "status": "403",
  "detail": "Component '{name}' already exists and cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009050",
  "name": "ContentNavMenu",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

リリース19.4.1.での導入。

403禁止 - ごみ箱でのコンポーネントの上書き

競合解決がoverwriteのコンポーネントがインポートされ、そのコンポーネントはすでに存在し、ごみ箱にあります。

エラー・コード

OCE-SITEMGMT-009108

解決 - コンポーネントを完全に削除

自分が所有者である場合は、コンポーネントを完全に削除します。 所有者でない場合は、所有者にコンポーネントを完全に削除するように依頼し、再試行してください。

解決 - コンポーネントのリストア

所有者である場合は、コンポーネントをリストアして再試行してください。

例外詳細フィールド

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

フィールド名説明
nameコンポーネント名
ownerコンポーネント所有者担当者詳細。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Overwrite In Trash",
  "status": "403",
  "detail": "Component '{name}' is in trash so cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009108",
  "name": "ContentNavMenu",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

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

403Forbidden - Component Create Denied

すでに存在するコンテンツ・レイアウト・コンポーネントをインポートする場合は、インポート時に上書きして新しいコンポーネントとして作成しないようにする必要があります。

エラー・コード

OCE-SITEMGMT-009068

解決 - コンポーネントの上書き

コンポーネントは、インポート中に上書きされる必要があります。 テンプレート・パッケージをインポートする場合は、コンポーネントの競合解決方法のforceCreateリストからコンポーネント名を削除します。 個々のコンポーネントをインポートするときに、overwrite競合解決を指定します。

例外詳細フィールド

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

フィールド名説明
nameコンポーネント名

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Create Denied",
  "status": "403",
  "detail": "Component '{name}' is for an existing content layout and cannot be created as a new component.",
  "o:errorCode": "OCE-SITEMGMT-009068",
  "name": "ContentNavMenu"
}

リリース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で導入されました。

403禁止 - サイト管理者ロール必須

このタイプのリソースを作成するには、サイト管理者ロールが必要です。

エラー・コード

OCE-SITEMGMT-009140

解決 - サイト・システム設定の変更

サイト、テンプレート、テーマおよびコンポーネントの作成は、サイト管理者に制限できます。 管理者以外のユーザーがこのタイプのサイト・リソースを作成できるように、サイト・システム設定を更新します。

例外詳細フィールド

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

フィールド名説明
resourceTypeサイト管理者のみが作成できるリソース・タイプ。 有効な値は次のとおりです。
  • site - サイト・リソース
  • template - テンプレート・リソース
  • theme - テーマ・リソース
  • component - コンポーネント・リソース
name作成中のリソースの名前(使用可能な場合)。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Sites Administrator Role Required",
  "status": "403",
  "detail": "The Sites Administrator role is required to create resources of this type.",
  "o:errorCode": "OCE-SITEMGMT-009140",
  "resourceType": "site",
  "name": "value"
}

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

409Conflict - Component Import Conflict

コンポーネントがインポートされると、同じ識別子または名前のコンポーネントが存在する場合、そのコンポーネントは既存のコンポーネントでクラッシュする可能性があります。

エラー・コード

OCE-SITEMGMT-009046

解決 - コンポーネントの競合

コンポーネント競合解決選択肢を使用して解決を指定: 新しいIdとオプション名を持つ新しいコンポーネントを作成するか、競合するコンポーネントを上書きする、インポートされたコンポーネントの名前を変更して名前の競合を回避する、またはコンポーネントのインポートをスキップします。

例外詳細フィールド

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

フィールド名説明
componentConflictsコンポーネントが競合しています。既存のコンポーネントと競合しています。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Import Conflict",
  "status": "409",
  "detail": "Component package has not been imported because there is one or more conflicts with the component.",
  "o:errorCode": "OCE-SITEMGMT-009046",
  "componentConflicts": [
      {
        "conflicts": [
            {
              "itemGUID": "value",
              "name": "ContentNavMenu",
              "type": "name",
              "value": "value",
              "resolution": "value"
            }
        ],
        "itemGUID": "value",
        "name": "ContentNavMenu",
        "ownedBy": {
          "type": "user",
          "id": "1234",
          "name": "value",
          "displayName": "John Smith",
          "roles": [
              "CECServiceAdministrator"
          ],
          "userName": "jsmith",
          "email": "jsmith@example.com"
        },
        "lastModifiedBy": {
          "type": "user",
          "id": "1234",
          "name": "value",
          "displayName": "John Smith",
          "roles": [
              "CECServiceAdministrator"
          ],
          "userName": "jsmith",
          "email": "jsmith@example.com"
        },
        "lastModifiedAt": "2019-06-01T06:44:17.000Z",
        "deleted": false,
        "overwritable": false,
        "component": {
          "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
        }
      }
  ]
}

リリース19.4.1.での導入。

409Conflict - Component Already Exists

同じ名前またはIdのコンポーネントがすでに存在します。 コンポーネントの名前とIdは、すべてのコンポーネント間で一意である必要があります。

エラー・コード

OCE-SITEMGMT-009043

解決 - コンポーネント名の変更

コピーまたは名前の変更中に名前を衝突する場合は、別の名前を選択してください。

解決 - 競合解決名の変更

インポート中に名前を付ける場合は、コンポーネントの競合解決に別の名前を選択してください。

解決 - 競合解決アクションの変更

インポート中にアイデンティティを衝突する場合は、コンポーネントの競合解決タイプをoverwriteまたはcreateに変更します。

例外詳細フィールド

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

フィールド名説明
componentコンポーネントが重複しています。
name重複している名前です
itemGuidアイデンティティGUIDが重複しています。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Already Exists",
  "status": "409",
  "detail": "A component with the same name or identity already exists.",
  "o:errorCode": "OCE-SITEMGMT-009043",
  "component": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  },
  "name": "ContentNavMenu",
  "itemGuid": "value"
}

リリース19.4.1.での導入。

リクエスト

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

コンポーネント・ファイルおよび競合解決の詳細。

ルート・スキーマ: schema
型: object
ソースを表示
  • conflicts

    コンポーネント競合解決の実行方法の詳細。 指定しない場合、インポートでは新しいコンポーネントの作成が試行されます。

    リリース19.4.1.での導入。

  • コンポーネント・パッケージ・ファイル。

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

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

例:
{
    "file":"path:packages/components/component.zip"
}
ネストされたスキーマ : 競合
型: object

コンポーネント競合解決の実行方法の詳細。 指定しない場合、インポートでは新しいコンポーネントの作成が試行されます。

リリース19.4.1.での導入。
ソースを表示
  • 最大長: 255

    renameを解決する場合は、コンポーネント名を指定する必要があります。 createの解決を選択した場合、コンポーネント名を指定することもできます。

    リリース19.4.1.での導入。

  • コンポーネントの競合の処理方法。

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

    • create - 同じIdのコンポーネントが存在する場合は、新しいidでコンポーネントをインポートします。 オプションで、新しいコンポーネント名ができます
    名前の競合を避けるために指定する必要があります。
    • rename - コンポーネントを新しい名前でインポートしますが、アイデンティティは維持します。 名前の変更による競合解決を選択した場合
    この場合、新しいコンポーネント名も指定する必要があります。
    • overwrite - 同じアイデンティティのコンポーネントが存在する場合、インポートするコンポーネントで競合するコンポーネントを上書きします
    • skip - 競合が発生している場合はコンポーネントをインポートしない

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

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

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

レスポンス

201レスポンス

作成日
ヘッダー

303レスポンス

他を参照
ヘッダー

400レスポンス

不正なリクエスト
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : InvalidFileExceptionDetail
リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • ExceptionDetail

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

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

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

ソースを表示

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

レスポンスの例(無効なファイル)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid File",
    "status":"400",
    "detail":"File does not exist or the authenticated user or client application does not have access to the file.",
    "o:errorCode":"OCE-DOCS-001002",
    "file":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    }
}
レスポンスの例(無効なインポート・ファイル)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Import File",
    "status":"400",
    "detail":"Invalid import file.",
    "o:errorCode":"OCE-SITEMGMT-009145"
}

401レスポンス

未認可

403レスポンス

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

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

ソースを表示

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

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

コンポーネント所有者担当者詳細。

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

    ユーザー担当者詳細。 ユーザーの表示名と電子メール・アドレスが含まれます。

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

ユーザー担当者詳細。 ユーザーの表示名と電子メール・アドレスが含まれます。

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

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

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

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

ソースを表示
  • links
ネストされたスキーマ : UserContact-allOf[1]
型: object
ソースを表示
レスポンスの例(コンポーネント上書きが拒否されました)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Overwrite Denied",
    "status":"403",
    "detail":"Component '{name}' already exists and cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009050",
    "name":"ContentNavMenu",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}
レスポンスの例(ごみ箱でのコンポーネントの上書き)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Overwrite In Trash",
    "status":"403",
    "detail":"Component '{name}' is in trash so cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009108",
    "name":"ContentNavMenu",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}
レスポンスの例(コンポーネントの作成が拒否されました)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Create Denied",
    "status":"403",
    "detail":"Component '{name}' is for an existing content layout and cannot be created as a new component.",
    "o:errorCode":"OCE-SITEMGMT-009068",
    "name":"ContentNavMenu"
}
レスポンスの例(ストレージ制限に達しました)
{
    "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
}
レスポンスの例(Sites Administrator Role Required)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Sites Administrator Role Required",
    "status":"403",
    "detail":"The Sites Administrator role is required to create resources of this type.",
    "o:errorCode":"OCE-SITEMGMT-009140",
    "resourceType":"site",
    "name":"value"
}

409レスポンス

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

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

ソースを表示

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

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

コンポーネントが競合しています。既存のコンポーネントと競合しています。

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

  • コンポーネントが競合しています。

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

    既存のコンポーネントとの競合のリスト。

    リリース19.4.1.での導入。

  • 競合するコンポーネントがソフト削除されるかどうかを指定します。

    リリース19.4.1.での導入。

  • 競合するコンポーネントの内部識別子。 これはフォルダGUIDと同じではありません。 この識別子は、2つの異なるサービス(テストおよび本番サービス)で同じコンポーネントを識別するために使用できます。 このGUIDは、コンポーネントのエクスポートおよびインポート時に保持されます。

    リリース19.4.1.での導入。

  • 競合するコンポーネントが最後に変更された日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

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

    競合するコンポーネントを最後に変更したユーザーまたはクライアント・アプリケーション。

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

    サービスの競合するコンポーネントの名前。

    リリース19.4.1.での導入。

  • 現在の認証済ユーザーにコンポーネント・コンテンツを上書きする権限があるかどうかを指定します。 コンテンツを上書きできるのはマネージャのみです。 値がfalseの場合、上書きの競合解決はアクセスが拒否されて失敗します。

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

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

    リリース19.4.1.での導入。
ネストされたスキーマ : 競合
型: array

既存のコンポーネントとの競合のリスト。

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

競合するコンポーネントを最後に変更したユーザーまたはクライアント・アプリケーション。

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

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

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

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

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

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

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

  • パッケージ内のコンポーネントの内部識別子。 これはフォルダGUIDと同じではありません。 この識別子は、2つの異なるサービス(テストおよび本番サービス)で同じコンポーネントを識別するために使用できます。 このGUIDは、コンポーネントのエクスポートおよびインポート時に保持されます。

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

    パッケージ内のコンポーネントの読み取り可能な名前。

    リリース19.4.1.での導入。

  • 解決値(該当する場合)。 この値を使用すると競合が解決されます。

    リリース19.4.1.での導入。

  • 競合のタイプ

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

    • name - コンポーネント名のコンポーネントが競合しています
    • identity - コンポーネントGUIDベースのアイデンティティでコンポーネントが競合しています

    リリース19.4.1.での導入。

  • 干渉値。

    リリース19.4.1.での導入。
ネストされたスキーマ: Identity
識別子: type

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

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

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

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

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

ソースを表示
  • links
ネストされたスキーマ : 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で導入されました。
ソースを表示
レスポンス例(コンポーネントのインポート競合)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Import Conflict",
    "status":"409",
    "detail":"Component package has not been imported because there is one or more conflicts with the component.",
    "o:errorCode":"OCE-SITEMGMT-009046",
    "componentConflicts":[
        {
            "conflicts":[
                {
                    "itemGUID":"value",
                    "name":"ContentNavMenu",
                    "type":"name",
                    "value":"value",
                    "resolution":"value"
                }
            ],
            "itemGUID":"value",
            "name":"ContentNavMenu",
            "ownedBy":{
                "type":"user",
                "id":"1234",
                "name":"value",
                "displayName":"John Smith",
                "roles":[
                    "CECServiceAdministrator"
                ],
                "userName":"jsmith",
                "email":"jsmith@example.com"
            },
            "lastModifiedBy":{
                "type":"user",
                "id":"1234",
                "name":"value",
                "displayName":"John Smith",
                "roles":[
                    "CECServiceAdministrator"
                ],
                "userName":"jsmith",
                "email":"jsmith@example.com"
            },
            "lastModifiedAt":"2019-06-01T06:44:17.000Z",
            "deleted":false,
            "overwritable":false,
            "component":{
                "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
            }
        }
    ]
}
レスポンスの例(コンポーネントはすでに存在します)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Already Exists",
    "status":"409",
    "detail":"A component with the same name or identity already exists.",
    "o:errorCode":"OCE-SITEMGMT-009043",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    },
    "name":"ContentNavMenu",
    "itemGuid":"value"
}

413 レスポンス

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

415 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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