メタデータ

メタデータとは、Commerbleが定義するCMSシステムの標準データです。
テンプレートやルーティング情報が該当します。メタデータのスキーマ仕様は固定でカスタマイズはできません。

メタデータは、Web API経由でアクセス可能です。

ListFields

リストのフィールドデータ。CMSスキーマのカラム情報として扱われます。

列名最大長主キーIdentityNULL許容説明
IdInt32OリストフィールドID
ListIdInt32OリストID
ColumnOrdinalInt32カラム番号
ColumnNameString60カラム名
DisplayTextString60O表示名
TypeIdInt32OタイプID
IsVersionedBooleanバージョンフィールドフラグ(廃止予定)
IsPrimaryKeyBooleanプライマリキーフラグ
IsNullableBooleanNULL許容フラグ

Lists

リストデータ。CMSスキーマのテーブル情報として扱われます。

列名最大長主キーIdentityNULL許容説明
IdInt32OリストID
RevisionInt32リビジョン番号(1固定)
TableNameString60テーブル名
DisplayTextString60O表示名
IdentityColumnNameString60O主キー用フィールド名
DisplayColumnNameString60O表示名用フィールド名
IsMasterInt32マスターデータリストフラグ
IsVersionedInt32バージョンリストフラグ(廃止予定)
CreaterUserInt32作成者
CreateAtInt32作成日
DeletedInt32ソフトデリートフラグ

ListRelations

リスト同士の関連データ

列名最大長主キーIdentityNULL許容説明
ListIdInt32OリストID
RelationIdInt32O関連ID
TargetListIdInt32関連先リストID
EditOrdinalInt32未使用(0固定)
UpdateCascadeInt32未使用(0固定)
DeleteCascadeInt32未使用(0固定)

ListRelationColumns

リスト関連の結合情報

列名最大長主キーIdentityNULL許容説明
ListIdInt32OキャンペーンID
RelationIdInt32O関連ID
ColumnNameString60O関連元フィールド名
TargetColumnNameString60関連先フィールド名

Types

フィールドタイプ

列名最大長主キーIdentityNULL許容説明
IdInt32OキャンペーンID
NameString50名称
DbTypeNameString40DB型名
DbDefaultValueString100DBデフォルト値
ClrTypeNameString250ランタイム型名
UrlConstraintStringMAXURL値検証正規表現
InputValidationStringMAX値検証正規表現
DefaultFieldTypeNameString100未使用(空文字固定)

RoutingParameters

ルーティングパラメータ

列名最大長主キーIdentityNULL許容説明
IdInt32OルーティングパラメータID
NameString128パラメータ名
ParameterTypeInt32パラメータ種類※
TypeIdInt32タイプID
ValueString128
HasValueBoolean128値フラグ

※ パラメータ種類 (1:ルートパラメータ、 2:クエリパラメータ、3:カスタムヘッダ)


Routings

ルーティング情報

列名最大長主キーIdentityNULL許容説明
IdInt32OルーティングID
NameString100ルーティング名
PatternString250ルーティングパターン
RouteTypeInt32ルーティングタイプ(1:テンプレート, 2:Blob)
ContentTypeString100コンテントタイプ
TemplateNameString80Oテンプレート名(RouteTypeが1の時のみ使用)
BlobExpressionString100OBlobカラム(RouteTypeが2の時のみ使用)
BlobQueryStringMAXOBlobクエリ(RouteTypeが2の時のみ使用)
LoadOrderInt32O優先順位(未使用)

RoutingDataTokens

列名最大長主キーIdentityNULL許容説明
IdInt32OルーティングデータトークンID
NameString128Oルーティングデータトークン名
ValueBinaryMAX

TemplateParameters

テンプレートパラメータ

列名最大長主キーIdentityNULL許容説明
IdInt32OテンプレートパラメータID
NameString50Oテンプレートパラメータ名
TypeIdInt32タイプID

Templates

テンプレート情報

列名最大長主キーIdentityNULL許容説明
IdInt32OテンプレートID
NameString256テンプレート名
TextStringMAXテンプレート
TypeString16テンプレートタイプ※

※テンプレートタイプ: template,cshtml,mail,csx


最終更新 : 2022-06-27 fix lint errors (3898b41)