getEntityMetadata (クライアント API)
指定したテーブルのテーブル定義を返します。
構文
Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)
Parameters
| 件名 | タイプ | Required | Description |
|---|---|---|---|
entityName |
String | はい | テーブルの論理名です。 |
attributes |
文字列の配列 | いいえ | 定義を取得する列です。 |
successCallback |
function | いいえ | テーブル定義が返されたときに呼び出される関数です。 |
errorCallback |
function | いいえ | 処理が失敗したときに呼び出す関数。 |
返品
種類: オブジェクト
説明: 次の値を持つテーブル定義情報を含むオブジェクトです。
| 件名 | タイプ | Description |
|---|---|---|
ActivityTypeMask |
回数 | カスタム活動をWeb アプリケーションの活動メニューに表示するかどうか。 0 はユーザー定義の活動が表示されないことを示し、1 は表示されることを示します。 |
AutoRouteToOwnerQueue |
ブール型 | この種類のレコードの作成または割り当て時に所有者の既定のキューにレコードを自動的に移動するかどうかを指定します。 |
CanEnableSyncToExternalSearchIndex |
ブール型 | 内部でのみ使用します。 |
CanTriggerWorkflow |
ブール型 | テーブルがワークフロープロセスをトリガーできるかどうかを示します。 |
Description |
String | テーブルの説明です。 |
DisplayCollectionName |
String | 複数のテーブルの表示名です。 |
DisplayName |
String | テーブルの表示名です。 |
EnforceStateTransitions |
ブール型 | テーブルがカスタムの状態遷移を実行するかどうかを示します。 |
EntityColor |
String | アプリケーションでこのテーブルに使用される色を表す 16 進コードです。 |
EntitySetName |
String | このテーブルに設定されている Web API テーブルの名前です。 |
HasActivities |
ブール型 | アクティビティがこのテーブルに関連付けられているかどうかを示します。 |
IsActivity |
ブール型 | テーブルがアクティビティであるかどうかを示します。 |
IsActivityParty |
ブール型 | 電子メール メッセージがこの種類のレコードに保存されている電子メール アドレスに送信できるかどうかを指定します。 |
IsBusinessProcessEnabled |
ブール型 | ビジネス プロセス フローでテーブルが有効になっているかどうかを示します。 |
IsBPFEntity |
ブール型 | ビジネス プロセス フロー テーブルが有効になっているかどうかを示します。 |
IsChildEntity |
ブール型 | テーブルが子テーブルであるかどうかを示します。 |
IsConnectionsEnabled |
ブール型 | このテーブルで接続が有効になっているかどうかを示します。 |
IsCustomEntity |
ブール型 | テーブルがカスタム テーブルであるかどうかを示します。 |
IsCustomizable |
ブール型 | テーブルがカスタマイズ可能であるかどうかを示します。 |
IsDocumentManagementEnabled |
ブール型 | ドキュメント管理が有効かどうかを示します。 |
IsDocumentRecommendationsEnabled |
ブール型 | ドキュメント レコメンデーションが有効であるかどうかを示します。 |
IsDuplicateDetectionEnabled |
ブール型 | 重複データ検出が有効かどうかを示します。 |
IsEnabledForCharts |
ブール型 | グラフが有効かどうかを示します。 |
IsImportable |
ブール型 | インポート ウィザードを使用してテーブルをインポートできるかどうかを示します。 |
IsInteractionCentricEnabled |
ブール型 | 対話型エクスペリエンスが可能なテーブルであることを示します。 |
IsKnowledgeManagementEnabled |
ブール型 | テーブルに対してナレッジ マネージメントが有効であるかどうかを示します。 |
IsMailMergeEnabled |
ブール型 | このテーブルで差し込み印刷が有効になっているかどうかを示します。 |
IsManaged |
ブール型 | テーブルが管理ソリューションの一部であるかどうかを示します。 |
IsOneNoteIntegrationEnabled |
ブール型 | テーブルに対して OneNote の統合が有効であるかどうかを示します。 |
IsOptimisticConcurrencyEnabled |
ブール型 | テーブルに対してオプティミスティック同時実行が可能であるかどうかを示します。 |
IsQuickCreateEnabled |
ブール型 | 簡易作成フォームでテーブルを有効にするかどうかを示します。 |
IsStateModelAware |
ブール型 | テーブルがカスタム状態遷移の設定をサポートしているかどうかを示します。 |
IsValidForAdvancedFind |
ブール型 | テーブルが高度な検索で表示されるかどうかを示します。 |
IsVisibleInMobileClient |
ブール型 | Microsoft Dynamics 365 for tablets のユーザーがこのテーブルのデータを表示できるかどうかを示します。 |
IsEnabledInUnifiedInterface |
ブール型 | 統一インターフェイスでテーブルが有効になっているかどうかを示します。 |
LogicalCollectionName |
String | 論理的なコレクション名。 |
LogicalName |
String | テーブルの論理名です。 |
ObjectTypeCode |
回数 | テーブルの種類コード。 |
OwnershipType |
String | テーブルの所有権タイプ: UserOwned または OrganizationOwned。 |
PrimaryIdAttribute |
String | テーブルのプライマリ ID である列の名前です。 |
PrimaryImageAttribute |
String | テーブルのプライマリ イメージ列の名前です。 |
PrimaryNameAttribute |
String | テーブルのプライマリ列の名前です。 |
Privileges |
オブジェクトの配列 | テーブルにアクセスするためのセキュリティ権限を定義するオブジェクト。 権限オブジェクト を参照してください |
Attributes |
コレクション | 列定義オブジェクトのコレクションです。 属性オブジェクト を参照してください |
権限オブジェクト
権限オブジェクトには、テーブルへのアクセスに対するセキュリティ権限を定義する次のプロパティがあります。
| 件名 | タイプ | Description |
|---|---|---|
CanBeBasic |
ブール型 | 特権はベーシックなアクセス レベルであり得るかどうか。 |
CanBeDeep |
ブール型 | 特権はディープなアクセス レベルであり得るかどうか。 |
CanBeEntityReference |
ブール型 | 外部パーティの特権がベーシックなアクセス レベルによって生成され得るかどうか。 |
CanBeGlobal |
ブール型 | 特権がグローバルなアクセス レベルであり得るかどうか。 |
CanBeLocal |
ブール型 | 特権がローカルなアクセス レベルであり得るかどうか。 |
CanBeParentEntityReference |
ブール型 | 外部パーティの特権が上位アクセス レベルによって生成され得るかどうか。 |
Name |
String | 特権の名前。 |
PrivilegeId |
String | 特権のID。 |
PrivilegeType |
回数 | 特権の種類で、次のいずれかである: 0: なし 1: 作成 2: 読み取り 3: 書き込み 4: 削除 5: 割り当て 6: 共有 7: 追加 8: AppendTo |
属性オブジェクト
返されるオブジェクトは、列定義のタイプによって異なります。
ベース (属性メタデータ) 列
すべての列定義には次の共有プロパティがあります。
| 件名 | タイプ | Description |
|---|---|---|
AttributeType |
回数 | 列のタイプです。 列タイプの値のリストについては、AttributeTypeCode Enum を参照してください |
DisplayName |
String | 列の表示名 |
EntityLogicalName |
String | 列を含むテーブルの論理名です。 |
LogicalName |
String | 列の論理名です。 |
Yes/No (BooleanAttributeMetadata) 列
Yes/No 列には次のプロパティがあります。
| 件名 | タイプ | Description |
|---|---|---|
DefaultFormValue |
ブール型 | はい/いいえ 列で使用する既定値です。 |
OptionSet |
Object | ブール値の列のオプションで、各オプションは key:value のペアです。 |
選択 (PicklistAttributeMetadata) 列
選択列には次のプロパティがあります。
| 件名 | タイプ | Description |
|---|---|---|
OptionSet |
Object | 列のオプションで、各オプションは key:value のペアです。 |
選択 (MultiSelectPicklistAttributeMetadata ) 列
選択列には次のプロパティがあります。
| 件名 | タイプ | Description |
|---|---|---|
DefaultFormValue |
ブール型 | 列の既定値です。 |
OptionSet |
Object | ブール値の列のオプションで、各オプションは key:value のペアです。 |
状態 (StateAttributeMetadata) 列
状態列には次のプロパティがあります。
| 件名 | タイプ | Description |
|---|---|---|
OptionSet |
Object | 列のオプションで、各オプションは key:value のペアです。 |
状態列には、OptionSet オプション値の 1 つの値を arg パラメータとして受け入れるこれらのメソッドもあります。
| 件名 | 返り値の種類 | Description |
|---|---|---|
getDefaultStatus(arg) |
回数 | テーブルに渡された状態値に基づいて、既定の状態 (数値) を返します。 テーブルの既定の状態と状態の値については、Dataverse テーブル/エンティティ リファレンス のテーブルの定義情報を参照してください。 |
getStatusValuesForState(arg) |
数値のアレイ | 指定された状態値の可能な状態値 (数値の配列) を返します。 テーブルの状態と状態の値については、Dataverse テーブル/エンティティ リファレンス のテーブルの定義情報を参照してください。 |
状態 (StatusAttributeMetadata) 列
状態列には次のプロパティがあります。
| 件名 | タイプ | Description |
|---|---|---|
OptionSet |
Object | 列のオプションで、各オプションは key:value のペアです。 |
状態列には、OptionSet オプション値の 1 つの値を arg パラメータとして受け入れるこのメソッドもあります。
| 件名 | 返り値の種類 | Description |
|---|---|---|
getState(arg) |
回数 | 指定された状態値 (数値) の状態値 (数値) を返します。 テーブルの既定の状態と状態の値については、Dataverse テーブル/エンティティ リファレンス のテーブルの定義情報を参照してください。 |
関連記事
注意
ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)
この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。