Web API プロパティ
CSDL $metadata ドキュメント内で、抽象的でない各エンティティ型は Property
要素を含みます。 各 Property
要素には次の属性があります。
Attribute | Description |
---|---|
Name |
プロパティの名前: 通常、列の LogicalName で、常に小文字です。 このルールに対する 1 つの例外は 検索プロパティです。 |
Type |
プロパティのプリミティブ型。 Dataverse が使用するプリミティブ型 を参照する |
メタデータ注釈のある $metadata ドキュメントを取得する場合、役立つ Annotation
要素が表示されます。 たとえば、次の name
と openrevenue
プロパティです。
<Property Name="name" Type="Edm.String" Unicode="false">
<Annotation Term="Org.OData.Core.V1.Description" String="Type the company or business name." />
</Property>
<Property Name="openrevenue" Type="Edm.Decimal" Scale="Variable">
<Annotation Term="Org.OData.Core.V1.Description" String="Sum of open revenue against an account and its child accounts." />
<Annotation Term="Org.OData.Core.V1.Computed" Bool="true" />
<Annotation Term="Org.OData.Core.V1.Permissions">
<EnumMember>Org.OData.Core.V1.PermissionType/Read</EnumMember>
</Annotation>
</Property>
この例の注釈から、openrevenue
フィールドが読み取り専用であることがわかります。
次の表では、 メタデータの注釈が適用されて返される注釈について説明します。
注釈の用語 | Description |
---|---|
Org.OData.Core.V1.Description |
プロパティの説明 |
Org.OData.Core.V1.Computed |
プロパティが計算されるかどうか; Dataverse によって計算されるため、読み取り専用です。 |
Org.OData.Core.V1.Permissions |
プロパティで使用可能なアクセス許可の種類が含まれます。 これは、アクセス許可が制限されている場合にのみ含まれ、常に値 <EnumMember>Org.OData.Core.V1.PermissionType/Read</EnumMember> が含まれます。つまり、この値は読み取り専用です。 |
注意
Org.OData.Core.V1.Computed
と Org.OData.Core.V1.Permissions
の注釈は頻繁に一緒に検索できますが、常にそうとは限りません。 どちらも、プロパティが読み取り専用であることを意味します。
Dataverse が使用するプリミティブ型
ビジネス データ用に使用するエンティティ型のプロパティは、プリミティブ型のみを含みます。 次の表は、Dataverse を使用するプリミティブ型を説明します。
タイプ | Description |
---|---|
Edm.Binary |
バイナリ データ。 ファイルおよび画像データに使用します。 |
Edm.Boolean |
バイナリ値ロジック。 |
Edm.Date |
タイムゾーン オフセットのない日付。 |
Edm.DateTimeOffset |
うるう秒のない、タイム ゾーンのオフセットを持つ日付と時刻 |
Edm.Decimal |
固定された小数以下の精度およびスケールを持つ数値 |
Edm.Double |
IEEE 754 binary64 浮動小数点数 (小数点以下 15 から 17 桁) |
Edm.Guid |
16 バイト (128 ビット) の一意の識別子 |
Edm.Int16 |
署名済 16 ビット整数。 特定のスキーマ EntityType プロパティにのみ使用されます |
Edm.Int32 |
署名済 32 ビット整数 |
Edm.Int64 |
署名済 64 ビット整数 |
Edm.String |
UTF-8 文字のシーケンス この種類には、 Unicode="false" ファセットが含まれる場合があります。このファセットが存在する場合、文字列プロパティには、ASCII 文字セットに制限された文字を含む文字列値のみが含まれ、受け入れられます。 値が指定されていない場合、Unicode ファセットは既定で true です。 |
検索プロパティ
一部のプロパティでは、_<name>_value
という命名規則が使用されます。 これらのプロパティは検索プロパティと呼ばれます。 検索プロパティは、Edm.Guid
値を持つ計算された読み取り専用プロパティです。 クエリ フィルターでこれらの検索プロパティを使用して、関連するすべてのレコードと多対一の関連付けの単一のレコードを照合できます。
OData は、検索列をプロパティではなく、単一値のナビゲーション プロパティ と表します。 Dataverse は、関連レコードの主キーを使用してデータを取得するシナリオを簡素化する検索プロパティを提供します。 検索プロパティの値を変更するには、それが表す単一値のナビゲーション プロパティを変更する必要があります。 詳細: 検索プロパティ
クエリに検索プロパティを含めると、単一値ナビゲーション プロパティで表されない基盤とする属性に設定されているデータの追加情報を提供する注釈を含めるよう要求できます。 詳細情報: プロパティデータの参照
次の手順
ナビゲーション プロパティについて説明します。
参照
Dataverse Web API の使用
Web API の種類および操作
Web API サービス ドキュメント
Web API EntityTypes
注意
ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)
この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。