ドメインの仕様

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

ドメインは、複数の API 定義にわたって使用されるパラメーター、応答、データモデルなどの仕様とマッピングのライブラリです。ドメイングループとバージョンに関連するドメイン仕様であり、特定のビジネスケースを表します。既定では、OpenAPI はドメイン仕様の最新バージョンで動作します。

ドメインは以下で構成されます。

ドメインのプロパティ
ドメインの仕様
EntityView
RelationView
SystemPropertiesView
RenditionView
ResourceView

ドメインのプロパティ

Sitecore Content Hub™ のオブジェクトには、次のプロパティが含まれます。

プロパティ	目的
Name	ドメインの名前
Description	ドメインの目的
Enabled	ドメインの状態
DomainIdentifier	ドメインの識別子 (OpenAPI のドキュメントを取得するために必要)
Specification	バージョン管理されたマッピングのコレクション

ドメイン仕様

ドメイン仕様は、統合のために Content Hub で必要な出力仕様を表します。これには以下が含まれます。

プロパティ	説明
entity_views	個別のエンティティマッピングのコレクション
version	仕様の一意の整数バージョン
status	ドメインステータス整数値: ドラフト (整数: 0) は既定のステータスです Active (整数: 1) 仕様は編集できません Disabled (int: 2) API 経由では取得できません

注意

ドメイン仕様の例については、M.Asset エンティティを使用したドメインのテストの例を参照してください。

EntityView

EntityView は、オンデマンドで取得するエンティティメンバーのサブセットを表します。これには以下が含まれます。

プロパティ	タイプ	目的
identifier	文字列	一意の識別子 (同じドメイン内で一意である必要があります)。
entity_definition_name	String	特定のエンティティビューに関連付けられているエンティティ定義の名前。
related_paths	オブジェクト	関連するパスを表示するかどうかを規定します。
public_links	Boolean	パブリックリンクを表示するかどうかを規定します。
display_name	Boolean	表示名を表示するかどうかを規定します。
languages	配列	含めるカルチャを規定します。
properties	配列	含めるプロパティを規定します。
relations	RelationView 要素のリスト	含めるリレーションを規定します。
システムプロパティ	SystemPropertiesView オブジェクト	含めるシステムプロパティを規定します。
renditions	RenditionViewオブジェクトのリスト	含めるレンディションを規定します。

RelationView

RelationView は、リレーション定義に基づいてオンデマンドでフェッチするエンティティメンバーのサブセットを表します。これには以下が含まれます。

プロパティ	目的
relation_name	リレーションの名前。リレーションを解決するために使用されます。
view	EntityView: 関連エンティティのビュー。
role	リレーションのロール。これは整数です [0: 子、1: 親]。

SystemPropertiesView

SystemPropertiesView は、抽出するエンティティのシステムプロパティのサブセットを表します。これには以下が含まれます。

プロパティ	タイプ	目的
created_by	Boolean	エンティティ作成者のユーザー名を表示するかどうかを規定します。
created_on	DateTime	作成の日付と時刻の表示方法を規定します。
id	Boolean	ID を表示するかどうかを規定します。
identifier	Boolean	識別子を表示するかどうかを規定します。
modified_by	Boolean	エンティティ変更者のユーザー名を表示するかどうかを規定します。
modified_on	DateTime	変更の日付と時刻の表示方法を規定します。
version	Boolean	エンティティのバージョンを表示するかどうかを規定します。

RenditionView

RenditionView は、抽出するエンティティからのレンディションのサブセットを表します。これには以下が含まれます。

プロパティ	目的
rendition_link_name	例: ミディアム、サムネイル、メタデータ、またはカスタムレンディション

ResourceView

ResourceView は、OpenAPI 呼び出しの出力を表します。Content HubAPI は、EntityView 構成を ResourceView に変換します。

ResourceView には以下が含まれます。

プロパティ	目的
properties	エンティティから抽出されたメンバープロパティ
relations	エンティティから抽出されたリレーション
public_links	エンティティから抽出されたパブリックリンク
renditions	エンティティから抽出されたレンディション
システムプロパティ	エンティティから抽出されたシステムプロパティ

OpenAPI クラス

次のクラスの図は、OpenAPI クラスを示しています。

ドメイン仕様テンプレート

次のテンプレートは、さまざまなタイプのドメインコンポーネントを示す Content Hub OpenAPI 3.0 ドメイン定義の例です。

[
{
"version": ##DomainSpecificationVersionInteger##,
"status": ##StatusInteger##,
"entity_views": {
"##ResourceViewId##": {
"identifier": "##ResourceViewId##",
"entity_definition_name": "##DefinitionName##",
"public_links": true,
"languages": [
"en-US"
],
"properties": [
"##PropertyNameString##"
],
"system_properties": {
"id": true,
"identifier": true,
"version": true,
"created_on": {
"language": "en-US",
"format": "dddd, MMMM dd, yyyy HH:mm:ss",
"utc_time_offset": "03:00"
},
"modified_on": {
"language": "en-US"
},
"created_by": true,
"modified_by": true
},
"relations": [
{
"relation_name": "##RelationName##",
"relation_role": 1,
"public_links": true,
"view": {
"identifier": "##AnyIdString##",
"entity_definition_name": "##RelatedEntityDefinitionName##",
"public_links": true,
"properties": [],
"relations": [],
"renditions": []
}
}
],
"renditions": [
{
"rendition_link_name": "##RenditionType##"
}
]
}
}
}
]

この記事を改善するための提案がある場合は、お知らせください!