リクエストURLの変数一覧
概要
APIリファレンスのリクエストURLで使われている変数についての説明
変数一覧
| 変数名 | 概要 | 備考 |
|---|---|---|
| {UnitURL} | Unitにアクセスする為のURL | URL:https://{UnitFQDN}/ |
| {UnitFQDN} | Personiumが動作しているサーバのFQDN Unitとは複数のCellをホストするサーバを指す | |
| {CellName} | Cell名 Cellとはデータ主体ごとのData Stroreを指す | |
| {CellURL} | Cellにアクセスする為のURL CellURLには"path based cell URL"と"per cell FQDN URL"の2種類が存在し、プロパティ(pathBasedCellUrl.enabled)で切替可能 | path based cell URL:https://{UnitFQDN}/{CellName}/ per cell FQDN URL:https://{CellName}.{UnitFQDN}/ |
| {BoxName} | Box名 Boxとはアプリケーションに用いるデータを格納する領域を指す | |
| {SchemaURL} | SchemaのURL SchemaとはPersonium内に格納されたSchemaを指す | |
| {RoleName} | Role名 RoleとはCellに対して定義される有効な「役割」を指す | |
| {AccountName} | Account名 AccountとはCellでのユーザ認証手段を表す | |
| {ExtCellURL} | ExtCellのURL ExtCell（外部Cell）とはあるCellから見たとき外にある他のCellを指す | |
| {RelationName} | Relation名 Relationとは自身（自Cell）と他者（外部Cell）との関係を示す | |
| {ExtRoleURL} | ExtRoleのURL ExtRole（外部Role）とは特定の関係にある外部Cell群において特定の役割（Role）を付与された利用者主体を指す | |
| {LogName} | ログファイル名 | |
| {MessageID} | MessageのID MessageとはCell間で送受信可能なメッセージを指す | |
| {CollectionName} | Collection名 Collectionとは通常のファイルシステムでいうところのフォルダ・ディレクトリに相当する | |
| {ResourcePath} | リソースへのパス Box配下のCollectionとファイルが対象となる | 有効値 桁数:1～256 |
| {OdataCollectionName} | OdataCollection名 OdataCollectionとはユーザがODataプロトコルで任意のリレーショナルデータを扱うための特殊WebDAV拡張コレクションを指す | |
| {EntityTypeName} | EntityType名 EntityTypeとはデータの構造をEntityDataModel(EDM)であらわすための定義体を指す | Entityの上位概念 |
| {AssociationEndName} | AssociationEnd名 AssociationEndとはAssociationを構成するエンドポイントとなっているEntityTypeを指す | |
| {ComplexTypeName} | ComplexType名 ComplexTypeとは下位属性を伴った属性を持つPropertyを指す | ComplexTypePropertyの上位概念 |
| {PropertyName} | Property名 各EntityTypeの列頭の値を指し、RDBにおけるテーブルの項目名に相当する | |
| {ComplexTypePropertyName} | ComplexTypeProperty名 ComplexTypePropertyとはComplexTypeの下位属性の名称を指す | ComplexTypeの下位属性 |
| {EntityName} | Entity名 Entityとはデータの記録構造を指し、RDBにおけるテーブル1行分に相当する | EntityTypeの下位属性 |
| {EntityID} | EntityのID | |
| {NavigationPropertyName} | NavigationProperty名 NavigationPropertyとはEntityDataModelやODataのデータ構造において、Associationの一方のEndから別のEndへのナビゲーションを表すPropertyを指す | |
| {ServiceSourceName} | ServiceSource名 ServiceとはServiceCollectionに登録されたユーザ定義のサーバサイドロジックを指す | |
| {ServiceName} | Service名 Serviceを実行する際に用いられる | ServiceSource名から拡張子を除いたもの |
| {QueueName} | Queue名 | 文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー) ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不 |
| {TopicName} | Topic名 | 文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー) ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可 |