如何查询所有现有字段的元数据

我们希望客户端能够发布到端点,例如:

[Route("Account", Name = "CreateAccount", Order = 1)] [HttpPost] public Account CreateAccount([FromBody] Account account) { var newAccount = _accountService.CreateAccountEntity(account); return newAccount; } 

我们知道这可以做到:

 POST [Organization URI]/api/data/v8.2/accounts HTTP/1.1 Content-Type: application/json; charset=utf-8 OData-MaxVersion: 4.0 OData-Version: 4.0 Accept: application/json { "name": "Sample Account", "creditonhold": false, "address1_latitude": 47.639583, "description": "This is the description of the sample account", "revenue": 5000000, "accountcategorycode": 1 } 

我们如何向消费者展示每个post/放置的要求?

要用不同的词来表达它, 如果我需要使用CRM 2016提供的Web API更新自定义或基本实体上的记录,我如何知道创建或更新实体需要哪些字段?

编辑:我尝试过Hank的方法,但这并没有返回实体的任何元数据: 在此处输入图像描述

您可以使用WebApi端点查询Dynamics 365元数据,如SDK中所示。

例如,要检索account实体的所有属性(包括需求级别):

 GET [Organization URI]/api/data/v8.2/EntityDefinitions(LogicalName='account')/Attributes HTTP/1.1 OData-MaxVersion: 4.0 OData-Version: 4.0 Accept: application/json Content-Type: application/json; charset=utf-8 

您可以使用RetrieveEntityRequest获取实体的元数据。

在以下示例中,检索实体Account的元数据:

 var request = new RetrieveEntityRequest { EntityFilters = EntityFilters.Entity | EntityFilters.Attributes, LogicalName = "account" }; var response = (RetrieveEntityResponse)_serviceProxy.Execute(request); 

响应对象包含EntityMetadata属性。 在其中,您可以找到如下属性的需求设置:

 EntityMetadata metadata = reponse.EntityMetadata; bool isRevenueRequired = metadata.Attributes .First(a -> a.LogicalName == "revenue") .RequiredLevel.Value == AttributeRequiredLevel.ApplicationRequired; 

为了使用SOAP端点获取实体的所有元数据,您可以使用RetrieveEntityRequest:

  var request = new RetrieveEntityRequest { EntityFilters = Microsoft.Xrm.Sdk.Metadata.EntityFilters.All, LogicalName = "account" } var response = (RetrieveEntityResponse)organizationService.Execute(request); 

EntityFiters是一个枚举,允许您指定要获取的元数据:

 [Flags] public enum EntityFilters { // // Summary: // Use this to retrieve only entity information. Equivalent to EntityFilters.Default. // Value = 1. Entity = 1, // // Summary: // Use this to retrieve only entity information. Equivalent to EntityFilters.Entity. // Value = 1. Default = 1, // // Summary: // Use this to retrieve entity information plus attributes for the entity. Value // = 2. Attributes = 2, // // Summary: // Use this to retrieve entity information plus privileges for the entity. Value // = 4. Privileges = 4, // // Summary: // Use this to retrieve entity information plus entity relationships for the entity. // Value = 8. Relationships = 8, // // Summary: // Use this to retrieve all data for an entity. Value = 15. All = 15 } 

这是一个标志枚举,所以你可以像这样使用它:

 var request = new RetrieveEntityRequest { EntityFilters = EntityFilters.Privileges | EntityFilters.Entity, LogicalName = "account" } 

或者只需使用All值来获取所有必需的元数据。 在您的尝试中,您无法检索元数据,因为您只询问了实体元数据,并且您对属性元数据感兴趣。

因此,以您的代码片段为基础,我将以下列方式使用它:

 [Route("Account", Name = "CreateAccount", Order = 1)] [HttpPost] public Account CreateAccount([FromBody] Account account) { VerifyRequiredFields(account); var newAccount = _accountService.CreateAccountEntity(account); return newAccount; } private void VerifyRequiredFields(Account account) { var response = GetEntityMetadata(account); var requiredAttributes = response.EntityMetadata.Attributes.Where(a => a.RequiredLevel?.Value == AttributeRequiredLevel.SystemRequired); foreach(var requiredAttribute in requiredAttributes) { if(CheckIfValueIsProvided(requiredAttribute.LogicalName, account)) { throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.BadRequest, $"You are missing required value {requiredAttribute.LogicalName}")); } } } 

方法GetEntityMetadata只是执行前面示例中的操作,因此调用RetrieveEntityRequest并返回RetrieveEntityResponse 。 当然,方法CheckIfValueIsProvided的实现取决于您的Account模型类的定义方式,但您可能需要在模型和CRM实体模型之间进行某种映射(以了解如何将示例字段“accountnumber”映射到您的某个字段中)模型)。 这远远超出了这个问题的范围,但我相信你已经足够了解这个问题了。 请记住,这只是一个例子。 您不应该将此逻辑保留在控制器类中,您应该将其移动到某个实用程序类,您可以在不同的控制器中重用它。 元数据不会经常更改(并且您可能已经控制了这些更改),因此您可能还希望在Web应用程序中的某处缓存元数据等。我希望您已经知道可以做什么,但整个设计如果逻辑是另一个故事。

如果你想用JavaScript做这个,你应该坚持使用webAPI:

 http://CRMADDRESS/api/data/v8.2/EntityDefinitions(LogicalName='account')/Attributes?$select=LogicalName,RequiredLevel 

将获得您想要的(属性名称及其所需级别)。 它看起来像这样:

 { "LogicalName":"preferredcontactmethodcodename","RequiredLevel":{ "Value":"None","CanBeChanged":false,"ManagedPropertyLogicalName":"canmodifyrequirementlevelsettings" },"MetadataId":"8663b910-af86-4dea-826e-8222706372f4" },{ "@odata.type":"#Microsoft.Dynamics.CRM.StringAttributeMetadata","LogicalName":"emailaddress3","RequiredLevel":{ "Value":"None","CanBeChanged":true,"ManagedPropertyLogicalName":"canmodifyrequirementlevelsettings" },"MetadataId":"97fb4aae-ea5d-427f-9b2b-9a6b9754286e" },{ "@odata.type":"#Microsoft.Dynamics.CRM.StringAttributeMetadata","LogicalName":"emailaddress2","RequiredLevel":{ "Value":"None","CanBeChanged":true,"ManagedPropertyLogicalName":"canmodifyrequirementlevelsettings" },"MetadataId":"98b09426-95ab-4f21-87a0-f6775f2b4210" },{ "@odata.type":"#Microsoft.Dynamics.CRM.StringAttributeMetadata","LogicalName":"emailaddress1","RequiredLevel":{ "Value":"None","CanBeChanged":true,"ManagedPropertyLogicalName":"canmodifyrequirementlevelsettings" },"MetadataId":"b254ab69-de5a-4edb-8059-bdeb6863c544" },{ "@odata.type":"#Microsoft.Dynamics.CRM.StringAttributeMetadata","LogicalName":"masteraccountidyominame","RequiredLevel":{ "Value":"None","CanBeChanged":false,"ManagedPropertyLogicalName":"canmodifyrequirementlevelsettings" },"MetadataId":"a15dedfc-9382-43ac-8d10-7773aa3eefeb" },{ "@odata.type":"#Microsoft.Dynamics.CRM.StringAttributeMetadata","LogicalName":"address1_city","RequiredLevel":{ "Value":"None","CanBeChanged":true,"ManagedPropertyLogicalName":"canmodifyrequirementlevelsettings" },"MetadataId":"ca8d0a94-8569-4154-b511-718e11635449" },{ "@odata.type":"#Microsoft.Dynamics.CRM.LookupAttributeMetadata","LogicalName":"slaid","RequiredLevel":{ "Value":"None","CanBeChanged":true,"ManagedPropertyLogicalName":"canmodifyrequirementlevelsettings" },"MetadataId":"6bdcd7f1-5865-4fef-91b0-676824b18641" } 

您可以使用它来validation客户端上的请求,以便在向服务器发送请求之前向用户提示他缺少重要数据。