getEntityMetadata (クライアント API)

指定したテーブルのテーブル定義を返します。

構文

Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)

パラメーター

名前 種類 必須 説明
entityName String 有効 テーブルの論理名です。
attributes 文字列の配列 無効 定義を取得する列です。
successCallback function 無効 テーブル定義が返されたときに呼び出される関数です。
errorCallback function 無効 処理が失敗したときに呼び出す関数。

返品

種類: オブジェクト

説明: 次の値を持つテーブル定義情報を含むオブジェクトです。

件名 内容
ActivityTypeMask カスタム活動をWeb アプリケーションの活動メニューに表示するかどうか。 0はユーザー定義の活動が表示されないことを示し、1は表示されることを示します。
AutoRouteToOwnerQueue Boolean この種類のレコードの作成または割り当て時に所有者の既定のキューにレコードを自動的に移動するかどうかを指定します。
CanEnableSyncToExternalSearchIndex Boolean 内部使用のみ。
CanTriggerWorkflow Boolean テーブルがワークフロープロセスをトリガーできるかどうかを示します。
内容 String テーブルの説明です。
DisplayCollectionName String 複数のテーブルの表示名です。
表示名 String テーブルの表示名です。
EnforceStateTransitions Boolean テーブルがカスタムの状態遷移を実行するかどうかを示します。
EntityColor String アプリケーションでこのテーブルに使用される色を表す 16 進コードです。
EntitySetName String このテーブルに設定されている Web API テーブルの名前です。
HasActivities Boolean アクティビティがこのテーブルに関連付けられているかどうかを示します。
IsActivity Boolean テーブルがアクティビティであるかどうかを示します。
IsActivityParty Boolean 電子メール メッセージがこの種類のレコードに保存されている電子メール アドレスに送信できるかどうかを指定します。
IsBusinessProcessEnabled Boolean ビジネス プロセス フローでテーブルが有効になっているかどうかを示します。
IsBPFEntity Boolean ビジネス プロセス フロー テーブルが有効になっているかどうかを示します。
IsChildEntity Boolean テーブルが子テーブルであるかどうかを示します。
IsConnectionsEnabled Boolean このテーブルで接続が有効になっているかどうかを示します。
IsCustomEntity Boolean テーブルがカスタム テーブルであるかどうかを示します。
IsCustomizable Boolean テーブルがカスタマイズ可能であるかどうかを示します。
IsDocumentManagementEnabled Boolean ドキュメント管理が有効かどうかを示します。
IsDocumentRecommendationsEnabled Boolean ドキュメント レコメンデーションが有効であるかどうかを示します。
IsDuplicateDetectionEnabled Boolean 重複データ検出が有効かどうかを示します。
IsEnabledForCharts Boolean グラフが有効かどうかを示します。
IsImportable Boolean インポート ウィザードを使用してテーブルをインポートできるかどうかを示します。
IsInteractionCentricEnabled Boolean 対話型エクスペリエンスが可能なテーブルであることを示します。
IsKnowledgeManagementEnabled Boolean テーブルに対してナレッジ マネージメントが有効であるかどうかを示します。
IsMailMergeEnabled Boolean このテーブルで差し込み印刷が有効になっているかどうかを示します。
IsManaged Boolean テーブルが管理ソリューションの一部であるかどうかを示します。
IsOneNoteIntegrationEnabled Boolean テーブルに対して OneNote の統合が有効であるかどうかを示します。
IsOptimisticConcurrencyEnabled Boolean テーブルに対してオプティミスティック同時実行が可能であるかどうかを示します。
IsQuickCreateEnabled Boolean 簡易作成フォームでテーブルを有効にするかどうかを示します。
IsStateModelAware Boolean テーブルがカスタム状態遷移の設定をサポートしているかどうかを示します。
IsValidForAdvancedFind Boolean テーブルが高度な検索で表示されるかどうかを示します。
IsVisibleInMobileClient Boolean Microsoft Dynamics 365 for tablets のユーザーがこのテーブルのデータを表示できるかどうかを示します。
IsEnabledInUnifiedInterface Boolean 統一インターフェイスでテーブルが有効になっているかどうかを示します。
LogicalCollectionName String 論理的なコレクション名。
LogicalName String テーブルの論理名です。
ObjectTypeCode テーブルの種類コード。
OwnershipType String テーブルの所有権タイプ : 「UserOwned」または「OrganizationOwned」。
PrimaryIdAttribute String テーブルのプライマリ ID である列の名前です。
PrimaryImageAttribute String テーブルのプライマリ イメージ列の名前です。
PrimaryNameAttribute String テーブルのプライマリ列の名前です。
特権 オブジェクトの配列 *それぞれの* オブジェクトのテーブルの特権の定義には、テーブルへのアクセスのセキュリティ特権を定義する以下の値が含まれています:
  • CanBeBasic: ブール値。 特権はベーシックなアクセス レベルであり得るかどうか。
  • CanBeDeep: ブール値。 特権はディープなアクセス レベルであり得るかどうか。
  • CanBeEntityReference: ブール値。 外部パーティの特権がベーシックなアクセス レベルによって生成され得るかどうか。
  • CanBeGlobal: ブール値。 特権がグローバルなアクセス レベルであり得るかどうか。
  • CanBeLocal: ブール値。 特権がローカルなアクセス レベルであり得るかどうか。
  • CanBeParentEntityReference: ブール値。 外部パーティの特権が上位アクセス レベルによって生成され得るかどうか。
  • Name: 文字列。 特権の名前。
  • PrivilegeId: 文字列。 特権のID。
  • PrivilegeType: 番号。 特権の種類で、次のいずれかである:
    • 0: なし
    • 1: 作成
    • 2: 読み取り
    • 3: 書き込み
    • 4: 削除
    • 5: 割り当て
    • 6: 共有
    • 7: 追加
    • 8: AppendTo
属性 集荷 列定義オブジェクトのコレクションです。 返されるオブジェクトは、列定義のタイプによって異なります。

ベースタイプの列定義
次のプロパティを持つオブジェクト返されます:

  • AttributeType: 番号。 列のタイプです。 列タイプの値のリストについては、 AttributeTypeCode を参照してください
  • DisplayName: 文字列。 列の表示名。
  • EntityLogicalName: 文字列。 列を含むテーブルの論理名です。
  • LogicalName: 文字列。 列の論理名です。

ブール値タイプの列定義
ベース列定義タイプのプロパティに加え、以下のプロパティを持つオブジェクトが返されます:

  • DefaultFormValue: ブール値。 はい/いいえ 列で使用する既定値です。
  • OptionSet: オブジェクト。 ブール値の列のオプションで、各オプションは key:value のペアです。

enumタイプの列定義
ベース列定義タイプのプロパティに加え、以下のプロパティを持つオブジェクトが返されます:

  • OptionSet: オブジェクト。 列のオプションで、各オプションは key:value のペアです。

選択タイプの列定義
ベース列定義タイプのプロパティに加え、以下のプロパティを持つオブジェクトが返されます:

  • DefaultFormValue: 番号。 列で使用する既定のフォーム値です。
  • OptionSet: オブジェクト。 列のオプションで、各オプションは key:value のペアです。

状態タイプの列定義
ベース列定義タイプのプロパティに加え、以下のプロパティを持つオブジェクトが返されます:

  • OptionSet: オブジェクト。 列のオプションで、各オプションは key:value のペアです。

オブジェクトには、次のメソッドも含まれています:

  • getDefaultStatus(arg):テーブルに渡された状態値に基づいて、既定の状態 (数値) を返します。 テーブルの既定の状態と状態の値については、テーブル/エンティティ リファレンスのテーブルの定義情報を参照してください。
  • getStatusValuesForState(arg): 指定された状態値の可能な状態値 (数値の配列) を返します。 テーブルの状態と状態の値については、テーブル/エンティティ リファレンスのテーブルの定義情報を参照してください。

状態タイプの列定義
ベース列定義タイプのプロパティに加え、以下のプロパティを持つオブジェクトが返されます:

  • OptionSet: オブジェクト。 列のオプションで、各オプションは key:value のペアです。

オブジェクトには、次のメソッドも含まれています:

  • getState(arg): 指定された状態値 (数値) の状態値 (数値) を返します。 テーブルの既定の状態と状態の値については、テーブル/エンティティ リファレンスのテーブルの定義情報を参照してください。

Xrm.Utility

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。