Partilhar via

Criar e atualizar definições de entidade usando API da Web

  • Artigo

 

Publicado: janeiro de 2017

Aplicável a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Você pode executar todas as mesmas entidades nas operações modelo que puder com o serviço da organização. Este artigo enfoca no trabalho com entidades de metadados que usam API da Web. Para localizar os detalhes das propriedades dos metadados da entidade, consulte Personalizar metadados da entidade e EntityMetadata EntityType.

Neste tópico

Criar entidades

Entidades atualizadas

Criar atributos

Criar entidades

Para criar uma entidade, POST a JSON representação da entidade no caminho da entidade EntityDefinitions. A entidade deve ser a definição do atributo de nome da entidade primária. Você não precisa definir valores das propriedades. Os itens da lista exceto por Description são necessários, apesar da configuração de uma descrição ser recomendada como melhor prática. Os valores de propriedade que você não especificar serão definidos como valores padrão. Para entender os valores padrão, observe o exemplo na seção Entidades atualizadas. O exemplo deste tópico usam as seguintes propriedades da entidade.

Propriedades de entidade

Valor

SchemaName

new_BankAccount

Observação

Você deve incluir o prefixo de personalização que corresponde ao fornecedor de soluções. O valor padrão “novo_” é usado, você deve escolher o prefixo que funciona para a solução.

DisplayName

Conta Bancária

DisplayCollectionName

Contas Bancárias

Description

Uma entidade para armazenar informações sobre contas bancárias de cliente.

OwnershipType

UserOwned

Observação

Para valores que você pode definir aqui, consulte OwnershipTypes EnumType.

IsActivity

false

HasActivities

false

HasNotes

false

Além das propriedades listadas anteriormente, EntityMetadataAttributes a propriedade deve conter uma matriz que contém um StringAttributeMetadata EntityType para representar o atributo de nome da entidade primária. A propriedade IsPrimaryName de atributo deve ser verdadeira. A tabela a seguir descreve as propriedades definidas no exemplo.

Atributo principal de propriedade

Valor

SchemaName

new_AccountName

RequiredLevel

None

Observação

Para valores que você pode definir aqui, consulte AttributeRequiredLevelManagedProperty ComplexType e AttributeRequiredLevel EnumType.

MaxLength

100

FormatName

Text

Observação

O atributo de nome primário deve usar o formato Text. Para formato das opções disponíveis para outros atributos da cadeia de caracteres, consulte Formatos StringAttributeMetadata.

DisplayName

Nome da Conta

Description

Digite o nome da conta bancária.

IsPrimaryName

true

Observação

Quando você cria ou atualiza os rótulos usando Label ComplexType, apenas é necessário definir a propriedade LocalizedLabels. O valor UserLocalizedLabel retornado se baseia na preferência de idioma do usuário e é somente leitura.

O exemplo a seguir mostra a criação de uma entidade personalizada que possui a propriedade definida. O idioma inglês está usando a identificação de localidade (LCID) de 1033.Os valores de ID de localidade válidos podem ser encontrados em Gráfico de LCID (ID de localidade).

  • Solicitação

    POST cc_WebAPI_ServiceURI/EntityDefinitions HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
  "@odata.type": "Microsoft.Dynamics.CRM.EntityMetadata",
 "Attributes": [
  {
   "AttributeType": "String",
   "AttributeTypeName": {
    "Value": "StringType"
   },
   "Description": {
     "@odata.type": "Microsoft.Dynamics.CRM.Label",
    "LocalizedLabels": [
     {
       "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
      "Label": "Type the name of the bank account",
      "LanguageCode": 1033
     }
    ]
   },
   "DisplayName": {
     "@odata.type": "Microsoft.Dynamics.CRM.Label",
    "LocalizedLabels": [
     {
       "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
      "Label": "Account Name",
      "LanguageCode": 1033
     }
    ]
   },
   "IsPrimaryName": true,
   "RequiredLevel": {
    "Value": "None",
    "CanBeChanged": true,
    "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings"
   },
   "SchemaName": "new_AccountName",
    "@odata.type": "Microsoft.Dynamics.CRM.StringAttributeMetadata",
   "FormatName": {
    "Value": "Text"
   },
   "MaxLength": 100
  }
 ],
 "Description": {
   "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "An entity to store information about customer bank accounts",
    "LanguageCode": 1033
   }
  ]
 },
 "DisplayCollectionName": {
   "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Bank Accounts",
    "LanguageCode": 1033
   }
  ]
 },
 "DisplayName": {
   "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Bank Account",
    "LanguageCode": 1033
   }
  ]
 },
 "HasActivities": false,
 "HasNotes": false,
 "IsActivity": false,
 "OwnershipType": "UserOwned",
 "SchemaName": "new_BankAccount"
}

  • Resposta

    HTTP/1.1 204 No Content
OData-Version: 4.0
OData-EntityId: cc_WebAPI_ServiceURI/EntityDefinitions(417129e1-207c-e511-80d2-00155d2a68d2)

Entidades atualizadas

Importante

Você não pode usar o método HTTP PATCH para atualizar as entidades modelo. Entidades de metadados ou com a paridade o serviço UpdateEntityRequest da organização que substitui a definição dessa entidade com o. Portanto, você deve usar o método HTTP PUT para atualizar as entidades e modelo, tome cuidado ao incluir todas as propriedades existentes que você não quiser alterar. Você não pode atualizar propriedades individuais.

Quando você atualiza entidades de metadados com rótulos, você deve incluir um cabeçalho MSCRM.MergeLabels personalizado para controlar os rótulos na atualização que devem ser processados. Se um rótulo para um item já tiver rótulos para outros idiomas e você atualizá-lo com um rótulo que contenha apenas um rótulo para um idioma específico, os controles de cabeçalho MSCRM.MergeLabels substituem os rótulos existentes ou mesclam o novo rótulo com os rótulos existentes do idioma. Com MSCRM.MergeLabels definido para true, todos os rótulos definidos novos ou existentes substituirão rótulos quando o código do idioma corresponder. Se desejar substituir os rótulos existentes para incluir somente os rótulos que você inclui, defina MSCRM.MergeLabels para false.

Importante

Se você não tiver um cabeçalho MSCRM.MergeLabels, o comportamento padrão é como se o valor for false e todos os rótulos localizados não incluídos na atualização será perdida.

Quando você atualiza uma entidade ou em um atributo, você deverá usar PublishXml Action ou PublishAllXml Action para que as alterações feitas sejam aplicadas ao aplicativo.Para obter mais informações:Publicar personalizações

Geralmente, você devolverá a definição JSON do atributo para as propriedades antes do envio novamente. O exemplo a seguir contém todas as propriedades dos metadados da entidade criada no exemplo Criar entidades, mas com DisplayName alterado para Bank Business Name. Observe que pode ser útil no JSON fornece os valores padrão das propriedades não definidas no exemplo Criar entidades.

  • Solicitação

    PUT cc_WebAPI_ServiceURI/EntityDefinitions(417129e1-207c-e511-80d2-00155d2a68d2) HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
MSCRM.MergeLabels: true

{
 "@odata.context": "cc_WebAPI_ServiceURI/$metadata#EntityDefinitions/$entity",
 "ActivityTypeMask": 0,
 "AutoRouteToOwnerQueue": false,
 "CanTriggerWorkflow": true,
 "Description": {
  "LocalizedLabels": [
   {
    "Label": "An entity to store information about customer bank accounts",
    "LanguageCode": 1033,
    "IsManaged": false,
    "MetadataId": "edc3abd7-c5ae-4822-a3ed-51734fdd0469",
    "HasChanged": null
   }
  ]
 },
 "DisplayCollectionName": {
  "LocalizedLabels": [
   {
    "Label": "Bank Accounts",
    "LanguageCode": 1033,
    "IsManaged": false,
    "MetadataId": "7c758e0c-e9cf-4947-93b0-50ec30b20f60",
    "HasChanged": null
   }
  ]
 },
 "DisplayName": {
  "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Bank Business Name",
    "LanguageCode": 1033
   }
  ]
 },
 "EntityHelpUrlEnabled": false,
 "EntityHelpUrl": null,
 "IsDocumentManagementEnabled": false,
 "IsOneNoteIntegrationEnabled": false,
 "IsInteractionCentricEnabled": false,
 "IsKnowledgeManagementEnabled": false,
 "AutoCreateAccessTeams": false,
 "IsActivity": false,
 "IsActivityParty": false,
 "IsAuditEnabled": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyauditsettings"
 },
 "IsAvailableOffline": false,
 "IsChildEntity": false,
 "IsAIRUpdated": false,
 "IsValidForQueue": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyqueuesettings"
 },
 "IsConnectionsEnabled": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyconnectionsettings"
 },
 "IconLargeName": null,
 "IconMediumName": null,
 "IconSmallName": null,
 "IsCustomEntity": true,
 "IsBusinessProcessEnabled": false,
 "IsCustomizable": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "iscustomizable"
 },
 "IsRenameable": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "isrenameable"
 },
 "IsMappable": {
  "Value": true,
  "CanBeChanged": false,
  "ManagedPropertyLogicalName": "ismappable"
 },
 "IsDuplicateDetectionEnabled": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyduplicatedetectionsettings"
 },
 "CanCreateAttributes": {
  "Value": true,
  "CanBeChanged": false,
  "ManagedPropertyLogicalName": "cancreateattributes"
 },
 "CanCreateForms": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "cancreateforms"
 },
 "CanCreateViews": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "cancreateviews"
 },
 "CanCreateCharts": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "cancreatecharts"
 },
 "CanBeRelatedEntityInRelationship": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canberelatedentityinrelationship"
 },
 "CanBePrimaryEntityInRelationship": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canbeprimaryentityinrelationship"
 },
 "CanBeInManyToMany": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canbeinmanytomany"
 },
 "CanEnableSyncToExternalSearchIndex": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canenablesynctoexternalsearchindex"
 },
 "SyncToExternalSearchIndex": false,
 "CanModifyAdditionalSettings": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyadditionalsettings"
 },
 "CanChangeHierarchicalRelationship": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canchangehierarchicalrelationship"
 },
 "IsOptimisticConcurrencyEnabled": true,
 "ChangeTrackingEnabled": false,
 "IsImportable": true,
 "IsIntersect": false,
 "IsMailMergeEnabled": {
  "Value": true,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifymailmergesettings"
 },
 "IsManaged": false,
 "IsEnabledForCharts": true,
 "IsEnabledForTrace": false,
 "IsValidForAdvancedFind": true,
 "IsVisibleInMobile": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifymobilevisibility"
 },
 "IsVisibleInMobileClient": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifymobileclientvisibility"
 },
 "IsReadOnlyInMobileClient": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifymobileclientreadonly"
 },
 "IsOfflineInMobileClient": {
  "Value": false,
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifymobileclientoffline"
 },
 "DaysSinceRecordLastModified": 0,
 "IsReadingPaneEnabled": true,
 "IsQuickCreateEnabled": false,
 "LogicalName": "new_bankaccount",
 "ObjectTypeCode": 10009,
 "OwnershipType": "UserOwned",
 "PrimaryNameAttribute": "new_accountname",
 "PrimaryImageAttribute": null,
 "PrimaryIdAttribute": "new_bankaccountid",
 "Privileges": [
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvCreatenew_BankAccount",
   "PrivilegeId": "d1a8de4b-27df-42e1-bc5c-b863e002b37f",
   "PrivilegeType": "Create"
  },
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvReadnew_BankAccount",
   "PrivilegeId": "726043b1-de2c-487e-9d6d-5629fca2bf22",
   "PrivilegeType": "Read"
  },
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvWritenew_BankAccount",
   "PrivilegeId": "fa50c539-b6c7-4eaf-bd49-fd8224bc51b6",
   "PrivilegeType": "Write"
  },
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvDeletenew_BankAccount",
   "PrivilegeId": "17c1fd6e-f856-45e7-b563-796f53108b85",
   "PrivilegeType": "Delete"
  },
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvAssignnew_BankAccount",
   "PrivilegeId": "133ca81d-668e-4c19-a71e-10c6dfe099cd",
   "PrivilegeType": "Assign"
  },
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvSharenew_BankAccount",
   "PrivilegeId": "15f27df4-9c67-47c9-b1f1-274e1c44f24a",
   "PrivilegeType": "Share"
  },
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvAppendnew_BankAccount",
   "PrivilegeId": "ac8b1920-8f93-4e9d-94e3-c680e2a2f228",
   "PrivilegeType": "Append"
  },
  {
   "CanBeBasic": true,
   "CanBeDeep": true,
   "CanBeGlobal": true,
   "CanBeLocal": true,
   "CanBeEntityReference": false,
   "CanBeParentEntityReference": false,
   "Name": "prvAppendTonew_BankAccount",
   "PrivilegeId": "f63a5f46-3bc7-4eac-81d0-7f77f566ef46",
   "PrivilegeType": "AppendTo"
  }
 ],
 "RecurrenceBaseEntityLogicalName": null,
 "ReportViewName": "Filterednew_BankAccount",
 "SchemaName": "new_BankAccount",
 "IntroducedVersion": "1.0",
 "IsStateModelAware": true,
 "EnforceStateTransitions": false,
 "EntityColor": null,
 "LogicalCollectionName": "new_bankaccounts",
 "CollectionSchemaName": "new_BankAccounts",
 "EntitySetName": "new_bankaccounts",
 "IsEnabledForExternalChannels": false,
 "IsPrivate": false,
 "MetadataId": "417129e1-207c-e511-80d2-00155d2a68d2",
 "HasChanged": null
}

  • Resposta

    HTTP/1.1 204 No Content
OData-Version: 4.0

Criar atributos

Você pode criar atributos ao mesmo tempo de criar a entidade incluindo JSON a definição dos atributos a matriz Attributes para a entidade que você posta além do atributo da cadeia de caracteres que atende o nome do atributo primário. Se quiser adicionar atributos para uma entidade que já foi criado, você poderá enviar POST uma solicitação que incluem JSON a definição desses itens para a entidade de propriedade de navegação de valor de coleção Attributes.

Criar um atributo de cadeia

O exemplo a seguir usará essas propriedades para criar um atributo da cadeia de caracteres.

propriedades do atributo String

Valores

SchemaName

new_BankName

DisplayName

Nome do Banco

Description

Digite o nome do banco.

RequiredLevel

None

MaxLength

100

FormatName

Text

O exemplo a seguir cria um atributo da cadeia de caracteres usando as propriedades e adicionando a entidade com o valor MetadataId de 402fa40f-287c-e511-80d2-00155d2a68d2. O URI para o atributo será retornado em resposta.

  • Solicitação

    POST cc_WebAPI_ServiceURI/EntityDefinitions(402fa40f-287c-e511-80d2-00155d2a68d2)/Attributes HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
 "AttributeType": "String",
 "AttributeTypeName": {
  "Value": "StringType"
 },
 "Description": {
  "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Type the name of the bank",
    "LanguageCode": 1033
   }
  ]
 },
 "DisplayName": {
  "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Bank Name",
    "LanguageCode": 1033
   }
  ]
 },
 "RequiredLevel": {
  "Value": "None",
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings"
 },
 "SchemaName": "new_BankName",
 "@odata.type": "Microsoft.Dynamics.CRM.StringAttributeMetadata",
 "FormatName": {
  "Value": "Text"
 },
 "MaxLength": 100
}

  • Resposta

    HTTP/1.1 204 No Content
OData-Version: 4.0
OData-EntityId: cc_WebAPI_ServiceURI/EntityDefinitions(402fa40f-287c-e511-80d2-00155d2a68d2)/Attributes(f01bef16-287c-e511-80d2-00155d2a68d2)

Criar um atributo monetário

O exemplo a seguir usará essas propriedades para criar um atributo monetário.

propriedades do atributo monetário

Valores

SchemaName

new_Balance

DisplayName

Saldo

Description

Insira o valor de saldo.

RequiredLevel

None

PrecisionSource

2

Observação

Para saber mais sobre os valores válidos do PrecisionSource, consulte a página Atributos de dados de quantidade. O valor 2 significa que o nível de precisão decimal corresponderá com TransactionCurrency.CurrencyPrecision que é associado com o registro atual.

O exemplo a seguir cria um atributo monetário usando as propriedades e adicionando a entidade com o valor MetadataId de 402fa40f-287c-e511-80d2-00155d2a68d2. O URI para o atributo será retornado em resposta.

  • Solicitação

    POST cc_WebAPI_ServiceURI/EntityDefinitions(402fa40f-287c-e511-80d2-00155d2a68d2)/Attributes HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
 "AttributeType": "Money",
 "AttributeTypeName": {
  "Value": "MoneyType"
 },
 "Description": {
  "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Enter the balance amount",
    "LanguageCode": 1033
   }
  ]
 },
 "DisplayName": {
  "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Balance",
    "LanguageCode": 1033
   }
  ]
 },
 "RequiredLevel": {
  "Value": "None",
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings"
 },
 "SchemaName": "new_Balance",
 "@odata.type": "Microsoft.Dynamics.CRM.MoneyAttributeMetadata",
 "PrecisionSource": 2
}

  • Resposta

    HTTP/1.1 204 No Content
OData-Version: 4.0
OData-EntityId: cc_WebAPI_ServiceURI/EntityDefinitions(402fa40f-287c-e511-80d2-00155d2a68d2)/Attributes(f11bef16-287c-e511-80d2-00155d2a68d2)

Criar um atributo datetime

O exemplo a seguir usará essas propriedades para criar um atributo datetime.

Propriedades do atributo datetime

Valores

SchemaName

new_Checkeddate

DisplayName

Data

Description

A data do saldo da conta foi confirmada.

RequiredLevel

Nenhum(a)

Format

DateOnly

Observação

Para as opções válidas para essa propriedade, consulte DateTimeFormat EnumType.

O exemplo a seguir cria um atributo datetime usando as propriedades e adicionando a entidade com o valor MetadataId de 402fa40f-287c-e511-80d2-00155d2a68d2. O URI para o atributo será retornado em resposta.

  • Solicitação

    POST cc_WebAPI_ServiceURI/EntityDefinitions(402fa40f-287c-e511-80d2-00155d2a68d2)/Attributes HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
 "AttributeType": "DateTime",
 "AttributeTypeName": {
  "Value": "DateTimeType"
 },
 "Description": {
  "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "The date the account balance was last confirmed",
    "LanguageCode": 1033
   }
  ]
 },
 "DisplayName": {
  "@odata.type": "Microsoft.Dynamics.CRM.Label",
  "LocalizedLabels": [
   {
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
    "Label": "Date",
    "LanguageCode": 1033
   }
  ]
 },
 "RequiredLevel": {
  "Value": "None",
  "CanBeChanged": true,
  "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings"
 },
 "SchemaName": "new_Checkeddate",
 "@odata.type": "Microsoft.Dynamics.CRM.DateTimeAttributeMetadata",
 "Format": "DateOnly"
}

  • Resposta

    HTTP/1.1 204 No Content
OData-Version: 4.0
OData-EntityId: cc_WebAPI_ServiceURI/EntityDefinitions(402fa40f-287c-e511-80d2-00155d2a68d2)/Attributes(fe1bef16-287c-e511-80d2-00155d2a68d2)

Criar um atributo de pesquisa de cliente

Ao contrário de outros atributos, um atributo de pesquisa de cliente é criado com a ação CreateCustomerRelationships. Os parâmetros para essa ação exigem a definição do atributo de pesquisa e um par de relações um-para-muitos. Um atributo de pesquisa de cliente tem duas relações um-para-muitos: uma para a entidade de conta e a outra para a entidade de contato.

O exemplo a seguir usará essas propriedades para criar um atributo de pesquisa de cliente.

Propriedades do atributo de pesquisa de cliente

Valores

SchemaName

new_CustomerId

DisplayName

Cliente

Description

Atributo de pesquisa de cliente de exemplo

O exemplo cria um atributo de pesquisa de cliente, new_CustomerId e o adiciona à entidade personalizada: new_bankaccount. A resposta é um tipo CreateCustomerRelationshipsResponse complexo.

  • Request

    POST 
      [URI da organização]/api/data/v8.2/CreateCustomerRelationships HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json
Content-Type: application/json; charset=utf-8

{
    "OneToManyRelationships": [{
        "SchemaName": "new_bankaccount_customer_account",
        "ReferencedEntity": "account",
        "ReferencingEntity": "new_bankaccount"
    }, {
        "SchemaName": "new_bankaccount_customer_contact",
        "ReferencedEntity": "contact",
        "ReferencingEntity": "new_bankaccount"
    }],
    "Lookup": {
        "AttributeType": "Lookup",
        "AttributeTypeName": {
            "Value": "LookupType"
        },
        "Description": {
            "@odata.type": "Microsoft.Dynamics.CRM.Label",
            "LocalizedLabels": [{
                "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
                "Label": "Sample Customer Lookup Attribute",
                "LanguageCode": 1033
            }],
            "UserLocalizedLabel": {
                "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
                "Label": "Sample Customer Lookup Attribute",
                "LanguageCode": 1033
            }
        },
        "DisplayName": {
            "@odata.type": "Microsoft.Dynamics.CRM.Label",
            "LocalizedLabels": [{
                "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
                "Label": "Customer",
                "LanguageCode": 1033
            }],
            "UserLocalizedLabel": {
                "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
                "Label": "Customer",
                "LanguageCode": 1033
            }
        },
        "SchemaName": "new_CustomerId",
        "@odata.type": "Microsoft.Dynamics.CRM.ComplexLookupAttributeMetadata"
    }
}

  • Response

    HTTP/1.1 200 OK
Content-Type: application/json; odata.metadata=minimal
OData-Version: 4.0

{
    "@odata.context": "
      [URI da organização]/api/data/v8.2/$metadata#Microsoft.Dynamics.CRM.CreateCustomerRelationshipsResponse",
    "RelationshipIds": [
        "a7d261bc-3580-e611-80d7-00155d2a68de", "aed261bc-3580-e611-80d7-00155d2a68de"
    ],
    "AttributeId": "39a5d94c-e8a2-4a41-acc0-8487242d455e"
}

Atualizar um atributo

Conforme mencionado em Entidades atualizadas, as entidades de modelo são atualizadas usando o método HTTP PUT dentro da definição completa de JSONdo item atual. Isso se aplicará nos atributos das entidades. Assim como com as entidades, você tem a opção de substituir rótulos usando o cabeçalho MSCRM.MergeLabels com o valor definido para false, e publique personalizações antes que estejam ativas no sistema.

Confira Também

Use o API da Web com metadados do Dynamics 365
Consultar metadados usando a API da Web
Recuperar metadados por nome ou por MetadataId
Criar e atualizar relacionamentos de entidade usando API da Web
Usar o serviço da Organização com metadados do Dynamics 365
Personalizar metadados do atributo de entidades

Microsoft Dynamics 365

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais