次の方法で共有

Dynamics 365 チャネル統合フレームワーク 1.0 の getEntityMetadata イベント (JavaScript API リファレンス)

  • [アーティクル]

指定されたエンティティのエンティティ メタデータを返します。

構文

Microsoft.CIFramework.getEntityMetadata(entityName, attributes).then(successCallback, errorCallback)

Parameters

件名 タイプ Required Description
entityName String 有効 エンティティの論理名です。
attributes 文字列の配列 無効 メタデータを取得する属性。

返品

種類: オブジェクト

説明: 次の属性を含むエンティティ メタデータ情報を含むオブジェクト。

属性名 種類 説明
ActivityTypeMask 数値 カスタム活動をWeb アプリケーションの活動メニューに表示するかどうか。 0はユーザー定義の活動が表示されないことを示し、1は表示されることを示します。
AutoRouteToOwnerQueue Boolean この種類のレコードの作成または割り当て時に所有者の既定のキューにレコードを自動的に移動するかどうかを指定します。
CanEnableSyncToExternalSearchIndex Boolean 内部のみで使用。
CanTriggerWorkflow Boolean エンティティがワークフロー プロセスをトリガーできるかどうかを指定します。
説明 String エンティティの説明。
DisplayCollectionName String エンティティの複数形での表示名。
DisplayName 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 がこのエンティティのデータを表示できるかどうかを指定します。
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: オブジェクト。 各オプションがキーであるブール値属性のオプション: 値のペア。

列挙の種類の属性のメタデータ
ベース属性メタデータの種類のプロパティに加えて、次のプロパティとともに返されるオブジェクト:

  • OptionSet: オブジェクト。 各オプションがキーである属性のオプション: 値のペア。

候補リストの種類の属性のメタデータ
ベース属性メタデータの種類のプロパティに加えて、次のプロパティとともに返されるオブジェクト:

  • DefaultFormValue: 数値。 属性の既定のフォーム値。
  • OptionSet: オブジェクト。 各オプションがキーである属性のオプション: 値のペア。

状態の種類の属性のメタデータ
ベース属性メタデータの種類のプロパティに加えて、次のプロパティとともに返されるオブジェクト:

  • OptionSet: オブジェクト。 各オプションがキーである属性のオプション: 値のペア。

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

  • getDefaultStatus(arg) : エンティティの状態値で渡されるもの基づいて既定のステータス(数値)を返します。 エンティティの既定の状態およびステータス値については、エンティティ参照のエンティティのエンティティ メタデータ情報を参照してください。
  • getStatusValuesForState(arg): 指定された状態値の可能な状態値 (数値の配列) を返します。 エンティティの状態およびステータス値については、エンティティ参照のエンティティのエンティティ メタデータ情報を参照してください。

状態の種類の属性のメタデータ
ベース属性メタデータの種類のプロパティに加えて、次のプロパティとともに返されるオブジェクト:

  • OptionSet: オブジェクト。 各オプションがキーである属性のオプション: 値のペア。

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

  • getState(arg): 指定された状態値 (数値) の状態値 (数値) を返します。 エンティティの既定の状態およびステータス値については、エンティティ参照のエンティティのエンティティ メタデータ情報を参照してください。