如何使用 Dynamics 365 XRM Tooling SDK 按主 ID 一般获取枚举的实体记录集

Question

我正在尝试编写一个通用方法，该方法给定任何 Dynamics 365 实体名称和一组 ID (GUIDS)，将响应一组与该枚举集匹配的实体记录。我感到沮丧的是，似乎没有一种有效的方法可以让 API 简单地使用“主 ID 密钥”而不首先从元数据中获取它，另一个（似乎不必要的）往返。

考虑以下（被黑）方法：

    public EntityCollection HackedFetchEntityRecordsById(IOrganizationService orgSvc, string entityName, IEnumerable<Guid> primaryEntityAttributeIds)
    {
        // Defacto HACK for getting primary entity attribute
        string primaryEntityAttribute = $"{entityName}id";

        StringBuilder sb = new StringBuilder();

        foreach (Guid guid in primaryEntityAttributeIds)
        {
            sb.AppendLine($@"<value>{guid}</value>");
        }

        string fetchXml = $@"
                    <fetch mapping='logical'>
                        <entity name='{entityName}'>
                            <no-attrs />
                            <filter>
                                <condition attribute='{primaryEntityAttribute}' operator='in'>
                                    {sb}
                                </condition>
                            </filter>
                        </entity>
                    </fetch> ";

        return orgSvc.RetrieveMultiple(new FetchExpression(fetchXml));
    }

请注意，这里我只是使用我观察到的事实标准，因为似乎 Microsoft 已选择使用实体名称后跟字符串“id”来命名实体上的主要 id 属性。这显然是不安全且糟糕的做法。

我可以以“正确”的方式做到这一点，但效率低下：

    public EntityCollection InefficientFetchEntityRecordsById(IOrganizationService orgSvc, string entityName, IEnumerable<Guid> primaryEntityAttributeIds)
    {
        // "Correct" but inefficient way of getting primary entity attribute
        string primaryEntityAttribute = ((RetrieveEntityResponse) orgSvc.Execute(new RetrieveEntityRequest
        {
            LogicalName = entityName
        })).EntityMetadata.PrimaryIdAttribute;

        StringBuilder sb = new StringBuilder();

        foreach (Guid guid in primaryEntityAttributeIds)
        {
            sb.AppendLine($@"<value>{guid}</value>");
        }

        string fetchXml = $@"
                    <fetch mapping='logical'>
                        <entity name='{entityName}'>
                            <no-attrs />
                            <filter>
                                <condition attribute='{primaryEntityAttribute}' operator='in'>
                                    {sb}
                                </condition>
                            </filter>
                        </entity>
                    </fetch> ";

        return orgSvc.RetrieveMultiple(new FetchExpression(fetchXml));
    }

请注意，在这种情况下，我需要进行单独的服务调用（包括所有开销）来获取实体元数据，以便辨别主要属性是什么。呸。

我想做类似以下（幻想/不工作）的方法：

    public EntityCollection FantasyFetchEntityRecordsById(IOrganizationService orgSvc, string entityName, IEnumerable<Guid> primaryEntityAttributeIds)
    {
        StringBuilder sb = new StringBuilder();

        foreach (Guid guid in primaryEntityAttributeIds)
        {
            sb.AppendLine($@"<value>{guid}</value>");
        }

        // ILLEGAL XML - made up element "primaryEntityAttribute"
        string fetchXml = $@"
                    <fetch mapping='logical'>
                        <entity name='{entityName}'>
                            <no-attrs />
                            <filter>
                                <primaryEntityAttribute operator='in'>
                                    {sb}
                                </primaryEntityAttribute>
                            </filter>
                        </entity>
                    </fetch> ";

        return orgSvc.RetrieveMultiple(new FetchExpression(fetchXml));
    }

我很乐意在 RetrieveMultiple 服务中使用其他一些 QueryBase 实现。

Answer 1

由于“hacked”方法在绝大多数情况下都应该有效，或许可以先尝试“hacked”方法，方法是在实体名称后附加id。如果失败，则检索实体元数据以获取 primaryId。

Answer 2

主键由CRM在创建实体时设置，格式为“实体名”+“id”，following this format isn't a hack。

如果您对此不满意，我会使用元数据服务批量检索一次详细信息。

RetrieveAllEntitiesRequest request = new RetrieveAllEntitiesRequest()
{
    EntityFilters = EntityFilters.Entity,
    RetrieveAsIfPublished = true
};

RetrieveAllEntitiesResponse response = (RetrieveAllEntitiesResponse)_serviceProxy.Execute(request);

foreach (EntityMetadata currentEntity in response.EntityMetadata)
{
    currentEntity.PrimaryIdAttribute
}

我不太确定这样做有什么顾虑，大概您正在为每个实体进行多次服务调用，一个额外的元数据调用不会受到伤害。至于期望服务器“只知道”这些信息；无论如何，它可能必须查询元数据表。

最后，如果有人必须向您提供实体名称，您也可以要求提供主键字段。