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

テンプレート・パッケージのインポート

post

/sites/management/api/v1/templates

COLLECTION

テンプレート・パッケージをインポートし、テンプレート、テーマおよびコンポーネントを作成します。 テンプレート・パッケージは、テンプレート、テーマおよびコンポーネントの詳細と構造を提供するzipファイルです。 テンプレート・パッケージ・ファイルは、最初に認証済ユーザーの個人フォルダにアップロードする必要があります。 このテンプレート・パッケージのファイルは、リクエスト本文フィールドの一部として指定する必要があります。 テンプレートとして、テーマまたはコンポーネントがすでに存在している場合があります。このテンプレート・パッケージのインポートを回避する競合が発生し、競合解決が指定されていない場合は、「テンプレートのインポートの競合」レスポンスが受信されます。 このレスポンスには、すべての競合に関する詳細が含まれています。 競合解消の詳細は、リクエスト本文のフィールドに指定できます。 競合解決が指定されている場合、インポートは指定された解決を使用して競合を解決しようとします。解決できない場合は、エラーで応答します。 競合解決処理の例としては、ターゲット・リソースの上書きや、新しいアイデンティティでのリソースの作成などがあります。

リリース19.4.1.での導入。

認可

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

  • CECDeveloperUser
  • CECContentAdministrator
  • CECSitesAdministrator

認可

サービス管理者がテンプレート作成をサイト管理者に限定した場合、サイト管理者のみがテンプレートを作成できます。

テンプレートからのサイトの作成

テンプレート、テーマおよびコンポーネントをインポートしたら、テンプレートからサイトを作成し、公開してアクティブ化できます。

詳細は、「サイトを作成」を参照してください。

テンプレートのエクスポート

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

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

テンプレートのインポート・ジョブの進捗の取得

テンプレートのインポートの進捗は、テンプレート・ジョブ・ステータスのリソースから監視できます。

詳細は、「テンプレート関連ジョブの進捗の取得」を参照してください。

非同期処理

この操作「のみ」非同期処理をサポートしています。 respond-asyncの値を持つPreferヘッダーがリクエストに含まれている必要があります。 「承認済」レスポンスにはLocationヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。

ステータスの読取りの詳細は、「テンプレート関連ジョブの進捗の取得」を参照してください。

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

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

pathファイル・パス

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

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

path:folder1/folder2/file.ext

リリース19.4.3での導入。

groupnameグループ名

「グループ」リソースのデフォルトの識別子は、Idです。

グループは、内部で生成されたグループ識別子ではなく、ヒューマン・フレンドリ・グループ名を使用して識別できます。

groupname:marketing

リリース19.3.1.での導入。

成功したレスポンスの例

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

202Accepted - Import with no Conflict Resolution

競合解決のないテンプレート・パッケージをインポートします。 リクエストに競合解決が指定されていないため、インポート・プロセスでは、テンプレート、テーマおよびコンポーネントを、アイデンティティや名前を変更せずにインポートしようとします。 既存のリソースと競合する場合、「テンプレートのインポートの競合」レスポンスが受信されます。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip"
}

202確定済 - 既存のテンプレート、テーマおよびコンポーネントの上書き

テンプレート・パッケージをシステムにインポートすると、同じアイデンティティですでに存在するテンプレート、テーマおよびコンポーネントが上書きされます。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip",
  "template": {
    "resolution": "overwrite"
  },
  "theme": {
    "resolution": "overwrite"
  },
  "components": {
    "resolution": "overwrite"
  }
}

202確定済 - 競合に関するテンプレート・インポートのスキップ

テーマおよびコンポーネントを上書きするテンプレート・パッケージをインポートしますが、テンプレート・パッケージのテンプレートがすでに存在する場合はスキップします。 これにより、既存のテンプレートは変更されず、テーマとコンポーネントのみが更新されます。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip",
  "template": {
    "resolution": "skip"
  },
  "theme": {
    "resolution": "overwrite"
  },
  "components": {
    "resolution": "overwrite"
  }
}

202確定済 - テンプレート名の変更、テーマおよびコンポーネントの上書き

テンプレート・パッケージをインポートして、テンプレートの名前を変更することによって競合を回避します。 テーマとコンポーネントの競合は、上書きによって解決されます。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip",
  "template": {
    "resolution": "rename",
    "name": "AnotherMarketing"
  },
  "theme": {
    "resolution": "overwrite"
  },
  "components": {
    "resolution": "overwrite"
  }
}

202確定済 - 新しい名前で新しいテンプレートを作成、テーマとコンポーネントを上書き

テンプレート・パッケージをインポートして新しいテンプレートを作成し、識別子と名前の両方に競合がある場合は名前を変更します。 テーマとコンポーネントの競合は、上書きによって解決されます。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip",
  "template": {
    "resolution": "create",
    "name": "AnotherMarketing"
  },
  "theme": {
    "resolution": "overwrite"
  },
  "components": {
    "resolution": "overwrite"
  }
}

202確定済 - 新規テンプレート、テーマの作成、コンポーネントの競合のレポート

テンプレート・パッケージをインポートして、新しいテンプレートとテーマを作成します。 コンポーネントの競合は、エラーを報告してインポートを停止することで解決されます。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip",
  "template": {
    "resolution": "create"
  },
  "theme": {
    "resolution": "create"
  },
  "components": {
    "resolution": "conflict"
  }
}

202確定済 - ファイル識別子でインポート

パスではなくファイル識別子を使用してファイルを識別する競合解決のないテンプレート・パッケージをインポートします。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "DFB85EFE755456CBF4079A2F27F9B329ABCCDE69AF2D"
}

202確定済 - インポートとすべての競合のスキップ

テンプレート・パッケージをインポートし、テンプレート、テーマおよびコンポーネントのすべての競合をスキップします。 競合するリソースはインポートされません。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip",
  "defaultResolution": "skip"
}
リリース22.5.2で導入されました。

202確定済 - マネージャ・グループのインポートおよび追加

テンプレート・パッケージをインポートし、マネージャ・ロールを持つメンバーとしてインポートされたテンプレート、テーマおよびコンポーネントに追加されるグループを指定します。

リクエスト

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

リクエスト・ヘッダー

Prefer=respond-async

リクエスト本文

{
  "file": "path:packages/templates/template.zip",
  "shareWith": "groupname:TemplateManagers"
}
リリース22.5.2で導入されました。

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

この操作は次のクライアント・エラー(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.での導入。

400Bad Request - Invalid Group

グループ名などの識別子で識別されたグループが見つかりません。

エラー・コード

OCE-IDS-001007

解決 - グループが存在するか確認

グループ識別子またはグループ名が有効であることを確認してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
group存在しないグループ。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Group",
  "status": "400",
  "detail": "Group does not exist.",
  "o:errorCode": "OCE-IDS-001007",
  "group": {
    "id": "1234"
  }
}

リリース19.3.1.での導入。

400不正なリクエスト - 無効なテンプレート・パッケージ構造

指定されたテンプレート・パッケージは必要な構造に準拠していません。

エラー・コード

OCE-SITEMGMT-009151

解決 - 必要なディレクトリを含める

テンプレート・パッケージに必要なすべてのディレクトリが含まれていることを確認してください。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
requiredDirectoriesパッケージにディレクトリがありません。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Template Package Structure",
  "status": "400",
  "detail": "The template package provided does not conform to the expected structure.",
  "o:errorCode": "OCE-SITEMGMT-009151",
  "requiredDirectories": [
      "value"
  ]
}

403Forbidden - Template Overwrite Denied

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

エラー・コード

OCE-SITEMGMT-009048

解決 - シェア・テンプレート

所有者は、ユーザーがテンプレートを上書きできるようにテンプレートのマネージャとしてユーザーを追加できます。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
nameテンプレート名
ownerテンプレート所有者の担当者詳細。

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

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

リリース19.4.1.での導入。

403禁止 - テンプレートのごみ箱での上書き

競合解決がoverwriteのテンプレートをインポートすると、テンプレートはすでに存在し、ごみ箱にあります。

エラー・コード

OCE-SITEMGMT-009110

解決 - テンプレートを完全に削除

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

解決 - テンプレートのリストア

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

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
nameテンプレート名
ownerテンプレート所有者の担当者詳細。

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

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

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

403Forbidden - Theme Overwrite Denied

overwriteの競合解決によってテーマがインポートされた場合、そのテーマはすでに存在しますが、認証済ユーザーには上書きする権限がありません。

エラー・コード

OCE-SITEMGMT-009049

解決 - テーマの共有

所有者は、ユーザーがテーマを上書きできるように、テーマのマネージャとしてユーザーを追加できます。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
nameテーマ名。
ownerテーマ所有者の連絡先の詳細。

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

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

リリース19.4.1.での導入。

403禁止 - ごみ箱でのテーマの上書き

競合解決がoverwriteのテーマをインポートすると、テーマはすでに存在し、ごみ箱にあります。

エラー・コード

OCE-SITEMGMT-009109

解決 - テーマを完全に削除

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

解決 - テーマのリストア

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

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
nameテーマ名。
ownerテーマ所有者の連絡先の詳細。

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

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

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

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.での導入。

403禁止 - コンテンツ・タイプ上書き拒否

エンタープライズ・テンプレートがインポートされ、コンテンツ・タイプがすでに存在するが、認証済ユーザーにはそれを上書きする権限がありません。

エラー・コード

OCE-SITEMGMT-009112

解決 - コンテンツ・タイプの共有

所有者は、ユーザーをコンテンツ・タイプのマネージャとして追加して、ユーザーが上書きできるようにします。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
nameコンテンツ・タイプ名。
ownerコンテンツ・タイプ所有者担当者詳細。

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

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

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

403Forbidden - Import Template with Assets Forbidden

アセットを含むテンプレートをインポートするには、コンテンツ管理者ロールが必要です。

エラー・コード

OCE-SITEMGMT-009113

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Import Template with Assets Forbidden",
  "status": "403",
  "detail": "The Content Administrator role is required to import a template with assets.",
  "o:errorCode": "OCE-SITEMGMT-009113"
}

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

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

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

409Conflict - Template Import Conflict

競合解消が指定されていないテンプレート・パッケージをインポートすると、既存のテンプレート、テーマまたはコンポーネントと競合します。 このエラー・レスポンスには、競合がすべて含まれています。

エラー・コード

OCE-SITEMGMT-009039

解決 - テンプレート競合の処理方法の指定

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

解決 - テーマ競合の処理方法の指定

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

解決 - コンポーネント競合の処理方法の指定

コンポーネントの競合の解決の選択肢を使用して、競合するコンポーネントを上書きすることを指定し、オプションで、上書きしないが新しい名前やIdで作成する必要のあるコンポーネントのセットを指定します。

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
conflictsテンプレート、テーマおよびコンポーネントの競合の詳細。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Import Conflict",
  "status": "409",
  "detail": "Template package has not been imported as there are one or more conflicts with the template, theme or components.",
  "o:errorCode": "OCE-SITEMGMT-009039",
  "conflicts": {
    "templateConflicts": [
        {
          "conflicts": [
              {
                "itemGUID": "value",
                "name": "CafeSupremo",
                "type": "name",
                "value": "value",
                "resolution": "value"
              }
          ],
          "itemGUID": "value",
          "name": "CafeSupremo",
          "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,
          "template": {
            "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
          }
        }
    ],
    "themeConflicts": [
        {
          "conflicts": [
              {
                "itemGUID": "value",
                "name": "CafeSupremoTheme",
                "type": "name",
                "value": "value",
                "resolution": "value"
              }
          ],
          "itemGUID": "value",
          "name": "CafeSupremoTheme",
          "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,
          "theme": {
            "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
          }
        }
    ],
    "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 - Template Already Exists

同じ名前またはIdのテンプレートがすでに存在します。 テンプレートの名前およびIdは、すべてのテンプレートを通して一意である必要があります。

エラー・コード

OCE-SITEMGMT-009040

解決 - テンプレート名の変更

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

解決 - 競合解決名の変更

インポート中に名前を付ける場合は、テンプレート競合解決に別の名前を選択します。

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

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

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

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

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

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

リリース19.4.1.での導入。

409Conflict - Theme Already Exists

同じ名前またはアイデンティティのテーマがすでに存在します。 テーマ名およびIdは、すべてのテーマ間で一意である必要があります。

エラー・コード

OCE-SITEMGMT-009042

解決 - テーマ名の変更

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

解決 - 競合解決名の変更

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

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

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

このエラーが返される場所
  • このエラー「次の場合があります」がレスポンス本文に返されました。
  • このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

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

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

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

リリース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.での導入。

409Conflict - Template Import In Progress

このエラーは、テンプレートのコピー(サイトの作成など)が行われるが、テンプレートのインポートによって上書きされる場合に発生します。

エラー・コード

OCE-SITEMGMT-009105

解決 - テンプレートのインポートが完了するまで待機

テンプレートのインポートが完了するまで待機し、再試行してください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
importedBy進行中のインポート・ジョブを作成したユーザーのフルネーム。
nameテンプレート名

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Import In Progress",
  "status": "409",
  "detail": "Unable to copy template as it is in the progress of being re-imported.",
  "o:errorCode": "OCE-SITEMGMT-009105",
  "importedBy": "value",
  "name": "CafeSupremo"
}

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

409Conflict - Component Import In Progress

このエラーは、コンポーネントがコピーされているが、同時にコンポーネント・インポートによって上書きされる場合に発生します。

エラー・コード

OCE-SITEMGMT-009107

解決 - コンポーネント・インポートの完了を待機

コンポーネントのインポートが完了するまで待ってから、再試行してください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
importedBy進行中のインポート・ジョブを作成したユーザーのフルネーム。
nameコンポーネント名

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Import In Progress",
  "status": "409",
  "detail": "Unable to access component as it is in the progress of being re-imported.",
  "o:errorCode": "OCE-SITEMGMT-009107",
  "importedBy": "value",
  "name": "ContentNavMenu"
}

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

409Conflict - Theme Import In Progress

このエラーは、テーマがコピーまたは公開されているが、テンプレートのインポートによって上書きされる場合に発生します。

エラー・コード

OCE-SITEMGMT-009106

解決 - テーマのインポートが完了するまで待機

テーマを上書きしているテンプレートのインポートが完了するまで待機し、再試行してください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド

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

フィールド名説明
importedBy進行中のインポート・ジョブを作成したユーザーのフルネーム。
nameテーマ名。

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

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Import In Progress",
  "status": "409",
  "detail": "Unable to access theme as it is in the progress of being re-imported.",
  "o:errorCode": "OCE-SITEMGMT-009106",
  "importedBy": "value",
  "name": "CafeSupremoTheme"
}

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

409競合 - Starter Editionのアセット・タイプの制限に達しました

Starter Editionのアセット・タイプの制限に達しました。

エラー・コード

OCE-SITEMGMT-009159

解決 - Premiumにアップグレード

無制限のアセット・タイプにアクセスするには、プレミアムにアップグレードしてください。

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Starter Edition Asset Types Limit Reached",
  "status": "409",
  "detail": "Starter edition limits the number of asset types that can be created.",
  "o:errorCode": "OCE-SITEMGMT-009159"
}

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

409競合 - 無効なタクソノミ・バージョン

インポートされたタクソノミ・バージョンが既存のタクソノミより低くなっています。

エラー・コード

OCE-SITEMGMT-009162

このエラーが返される場所
  • このエラー「行わない」がレスポンス本文に返されます。
  • このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Taxonomy Version",
  "status": "409",
  "detail": "Imported taxonomy version is lower than the existing taxonomy.",
  "o:errorCode": "OCE-SITEMGMT-009162"
}

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

リクエスト

サポートされているメディア・タイプ
ヘッダー・パラメータ

  • respond-asyncヘッダー値を使用してリクエストの非同期処理をリクエストします。

本文()

テンプレート・パッケージおよび競合の解決の詳細。

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

    コンポーネント競合解決の実行方法の詳細。

    リリース19.4.1.での導入。

  • テンプレート、テーマおよびコンポーネントのデフォルトの競合解決。

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

    • overwrite - 同じアイデンティティを持つリソースが存在する場合は、インポートされるリソースと競合するリソースを上書きします
    • skip - 競合がある場合は、リソースをインポートしないでください

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

  • テンプレート・パッケージ・ファイル。

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

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

  • テンプレート、テーマ、コンポーネントなど、インポートされたアーティファクトが共有されるオプションのグループ名または識別子。 グループにはマネージャ・ロールが付与されます。

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

    テンプレート競合解決の実行方法の詳細。

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

    テーマ競合解決の実行方法の詳細。

    リリース19.4.1.での導入。
例:
{
    "file":"path:packages/templates/template.zip"
}
ネストされたスキーマ: components
型: object

コンポーネント競合解決の実行方法の詳細。

リリース19.4.1.での導入。
ソースを表示
  • forceCreate

    コンポーネント名のリスト。新しいコンポーネントがすでに存在する場合は常に作成する必要があります。 コンポーネント名がすでに使用されている場合、新しいコンポーネント名は既存の名前とサフィクスを使用して自動的に生成されるため、一意になります。 このリストにないコンポーネントは、解決フィールドの値に応じて上書きされるか、競合レスポンスの原因となります。

    リリース19.4.1.での導入。

  • forceCreateフィールドにリストされていないコンポーネントにおけるコンポーネントの競合の処理方法。

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

    • conflict - 競合が発生している場合はコンポーネントをインポートしないでください。エラーで応答
    • overwrite - コンポーネント・パッケージ内のコンポーネントでコンポーネントを上書き

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

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

ソースを表示
ネストされたスキーマ : template
型: object

テンプレート競合解決の実行方法の詳細。

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

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

    リリース19.4.1.での導入。

  • テンプレートの競合を処理する方法。

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

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

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

テーマ競合解決の実行方法の詳細。

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

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

    リリース19.4.1.での導入。

  • テーマの競合を処理する方法。

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

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

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

コンポーネント名のリスト。新しいコンポーネントがすでに存在する場合は常に作成する必要があります。 コンポーネント名がすでに使用されている場合、新しいコンポーネント名は既存の名前とサフィクスを使用して自動的に生成されるため、一意になります。 このリストにないコンポーネントは、解決フィールドの値に応じて上書きされるか、競合レスポンスの原因となります。

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

レスポンス

202レスポンス

Accepted
ヘッダー

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 Group",
    "status":"400",
    "detail":"Group does not exist.",
    "o:errorCode":"OCE-IDS-001007",
    "group":{
        "id":"1234"
    }
}
レスポンスの例(無効なテンプレート・パッケージ構造)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Template Package Structure",
    "status":"400",
    "detail":"The template package provided does not conform to the expected structure.",
    "o:errorCode":"OCE-SITEMGMT-009151",
    "requiredDirectories":[
        "value"
    ]
}

401レスポンス

未認可

403レスポンス

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

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

ソースを表示

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

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

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

  • o:errorDetails

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

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

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

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

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

ネストされたスキーマ : TemplateOverwriteDeniedExceptionDetail-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":"Template Overwrite Denied",
    "status":"403",
    "detail":"Template '{name}' already exists and cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009048",
    "name":"CafeSupremo",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}
レスポンスの例(ごみ箱でのテンプレート上書き)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Overwrite In Trash",
    "status":"403",
    "detail":"Template '{name}' is in trash so cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009110",
    "name":"CafeSupremo",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}
レスポンスの例(テーマ上書きが拒否されました)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Overwrite Denied",
    "status":"403",
    "detail":"Theme '{name}' already exists and cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009049",
    "name":"CafeSupremoTheme",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}
レスポンスの例(ごみ箱での上書き)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Overwrite In Trash",
    "status":"403",
    "detail":"Theme '{name}' is in trash so cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009109",
    "name":"CafeSupremoTheme",
    "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 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":"Content Type Overwrite Denied",
    "status":"403",
    "detail":"Content type '{name}' already exists and cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009112",
    "name":"value",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}
レスポンスの例(アセットのインポートが禁止されているテンプレートのインポート)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Import Template with Assets Forbidden",
    "status":"403",
    "detail":"The Content Administrator role is required to import a template with assets.",
    "o:errorCode":"OCE-SITEMGMT-009113"
}
レスポンスの例(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
すべてに一致
ソースを表示
ネストされたスキーマ : TemplateImportConflictExceptionDetail
リリース19.4.1.での導入。
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

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

ソースを表示

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

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

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

ネストされたスキーマ : 競合
型: object

テンプレート、テーマおよびコンポーネントの競合の詳細。

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

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

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

テンプレートの競合。既存のテンプレートとの競合が含まれます。

リリース19.4.1.での導入。
ソースを表示
ネストされたスキーマ : themeConflicts
型: 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で導入されました。
ソースを表示
ネストされたスキーマ: items
型: object
ソースを表示
  • 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.での導入。
  • 最大長: 242

    サービス内の競合するテンプレートの名前。

    リリース19.4.1.での導入。

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

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

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

    リリース19.4.1.での導入。

  • テンプレートが競合しています。

    リリース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.での導入。
  • 最大長: 242

    パッケージ内のテンプレートの読み取り可能な名前。

    リリース19.4.1.での導入。

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

    リリース19.4.1.での導入。

  • 競合のタイプ

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

    • name - テンプレート名のテンプレート競合
    • identity - テンプレートGUアイデンティティ・ベースのアイデンティティでテンプレートが競合しています

    リリース19.4.1.での導入。

  • 干渉値。

    リリース19.4.1.での導入。
ネストされたスキーマ: items
型: object
ソースを表示
  • 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の場合、overwriteの競合解決はアクセスが拒否されて失敗します。

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

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

    リリース19.4.1.での導入。

  • 競合するテーマ。

    リリース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 - テーマのGUアイデンティティ・ベースの個人情報でテーマが競合しています

    リリース19.4.1.での導入。

  • 干渉値。

    リリース19.4.1.での導入。
レスポンス例(テンプレート・インポート競合)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Import Conflict",
    "status":"409",
    "detail":"Template package has not been imported as there are one or more conflicts with the template, theme or components.",
    "o:errorCode":"OCE-SITEMGMT-009039",
    "conflicts":{
        "templateConflicts":[
            {
                "conflicts":[
                    {
                        "itemGUID":"value",
                        "name":"CafeSupremo",
                        "type":"name",
                        "value":"value",
                        "resolution":"value"
                    }
                ],
                "itemGUID":"value",
                "name":"CafeSupremo",
                "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,
                "template":{
                    "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
                }
            }
        ],
        "themeConflicts":[
            {
                "conflicts":[
                    {
                        "itemGUID":"value",
                        "name":"CafeSupremoTheme",
                        "type":"name",
                        "value":"value",
                        "resolution":"value"
                    }
                ],
                "itemGUID":"value",
                "name":"CafeSupremoTheme",
                "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,
                "theme":{
                    "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
                }
            }
        ],
        "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":"Template Already Exists",
    "status":"409",
    "detail":"A template with the same name or identity already exists.",
    "o:errorCode":"OCE-SITEMGMT-009040",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    },
    "name":"CafeSupremo",
    "itemGuid":"value"
}
レスポンスの例(テーマはすでに存在します)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Already Exists",
    "status":"409",
    "detail":"A theme with the same name or identity already exists.",
    "o:errorCode":"OCE-SITEMGMT-009042",
    "theme":{
        "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
    },
    "name":"CafeSupremoTheme",
    "itemGuid":"value"
}
レスポンスの例(コンポーネントはすでに存在します)
{
    "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レスポンス

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