DYNAMICS 365 HOW TO CREATE AND MANAGE POLYMORPHIC LOOKUP ATTRIBUTE IN WEBAPI

Previously, we saw how to create a Polymorphic Lookup Attribute using the Polymorphic Lookup Manager plugin and how to create a Polymorphic Lookup Attribute using SDK

In this post, we will see how to create a Polymorphic Lookup Attribute using WebAPI. We will see as well, what are the different actions that can be done against a polymorphic lookup attribute using this method.

  1. In order to apply these actions, I will be using Postman to call the needed APIs requests
  2. First, you have to create an App Registration in Azure and enable its options as explained in this post to be able to connect to Dynamics 365 environment through Postman using the OAUTH authentication
  3. After connecting to Dynamics 365 environment in Postman, you have to send a POST request to create the Polymorphic Lookup Attribute with its relationships.

    In this exemple, I will create the Polymorphic Lookup Attribute with four relationships under the account table
    • Method: POST
    • API request URL: https://<ORGURL>/api/data/v9.2/CreatePolymorphicLookupAttribute
    • Request body:
      {
      "OneToManyRelationships": [
      {
      "SchemaName": "account_cak_contractor",
      "ReferencingEntity": "account",
      "ReferencedEntity": "cak_contractor"
      },
      {
      "SchemaName": "account_cak_education",
      "ReferencingEntity": "account",
      "ReferencedEntity": "cak_education"
      },
      {
      "SchemaName": "account_cak_health",
      "ReferencingEntity": "account",
      "ReferencedEntity": "cak_health"
      },
      {
      "SchemaName": "account_cak_university",
      "ReferencingEntity": "account",
      "ReferencedEntity": "cak_university"
      }
      ],

      "Lookup": {
      "AttributeType": "Lookup",
      "AttributeTypeName": {
      "Value": "LookupType"
      },

      "Description": {
      "@odata.type": "Microsoft.Dynamics.CRM.Label",
      "LocalizedLabels": [
      {
      "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
      "Label": "Parent Sector",
      "LanguageCode": 1033
      }
      ],

      "UserLocalizedLabel": {
      "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
      "Label": "Parent Sector",
      "LanguageCode": 1033
      }
      },

      "DisplayName": {
      "@odata.type": "Microsoft.Dynamics.CRM.Label",
      "LocalizedLabels": [
      {
      "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
      "Label": "Parent Sector",
      "LanguageCode": 1033
      }
      ],

      "UserLocalizedLabel": {
      "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
      "Label": "Parent Sector",
      "LanguageCode": 1033
      }
      },

      "SchemaName": "cak_ParentSectorId",
      "@odata.type": "Microsoft.Dynamics.CRM.ComplexLookupAttributeMetadata"
      }
      }
    • Reponse: N:1 Relationship Guids and Polymorphic Lookup Attribute Guid
    Polymorphic lookup webapi 1

    Polymorphic lookup webapi 2

  4. Once the Polymorphic Lookup Attribute is created, you can achieve the following actions against it using WebAPI
    • Add new relationship to an existing Polymorphic Lookup Attribute
      • Method: POST
      • API request URL: https://<ORGURL>/api/data/v9.2/RelationshipDefinitions
      • Request body:
        {
        "SchemaName": "cak_account_contact",
        "@odata.type": "Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata",
        "ReferencedEntity": "contact",
        "ReferencingEntity": "account",
        "Lookup": {
        "AttributeType": "Lookup",

        "AttributeTypeName": {
        "Value": "LookupType"
        },

        "Description": {
        "@odata.type": "Microsoft.Dynamics.CRM.Label",
        "LocalizedLabels": [
        {
        "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
        "Label": "Parent Sector",
        "LanguageCode": 1033
        }
        ],

        "UserLocalizedLabel": {
        "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
        "Label": "Parent Sector",
        "LanguageCode": 1033
        }
        },

        "DisplayName": {
        "@odata.type": "Microsoft.Dynamics.CRM.Label",
        "LocalizedLabels": [
        {
        "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
        "Label": "Parent Sector",
        "LanguageCode": 1033
        }
        ],

        "UserLocalizedLabel": {
        "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
        "Label": "Parent Sector",
        "LanguageCode": 1033
        }
        },
        "SchemaName": "cak_ParentSectorId",
        "@odata.type": "Microsoft.Dynamics.CRM.LookupAttributeMetadata"
        }
        }
      • Reponse: No content response with 204 Status that indicates the success of the request
      Polymorphic lookup webapi 3

      Polymorphic lookup webapi 4

    • Delete a relationship from an existing Polymorphic Lookup Attribute
      • Method: DELETE
      • API request URL: https://<ORGURL>/api/data/v9.2/RelationshipDefinitions(<RELATIONSHIPGUID>)
      • Request body: Empty body
      • Reponse: No content response with 204 Status that indicates the success of the request
      Polymorphic lookup webapi 5

    • Delete an existing Polymorphic Lookup Attribute
      • Method: DELETE
      • API request URL: https://<ORGURL>/api/data/v9.2/EntityDefinitions(<ENTITYGUID>)/Attributes(<ATTRIBUTEGUID>)
      • Request body: Empty body
      • Reponse: No content response with 204 Status that indicates the success of the request
      Polymorphic lookup webapi 6


Hope This Helps!

Comments

Post a Comment

Popular posts from this blog

DYNAMICS 365 FILTER LOOKUP FIELD BASED ON N:N RELATIONSHIP

Image
How to filter a Lookup field based on a N:N relationship of a parent entity using JavaScript . To show you this, I will use the Account entity, the Contact entity, and a custom entity Conference . The contact entity has a N:1 relation with the account entity (lookup field) The contact entity has a N:1 relation with the conference entity (lookup field) The account entity has a N:N relation with the conference entity (sub-grid) I need to filter the conference lookup of the contact entity to list The conference records that are related to the contact parent account or The conference records that are not related to any account Based on the above conditions, the users will not be able to ch...
Read more

DYNAMICS 365 LEVEL UP BROWSER EXTENSION - PART 1 - FORMS

Image
Level up for Dynamics 365/Power Apps is a browser extension in Edge, Google Chrome, and Firefox that can help users to perform advanced actions related to Dynamics 365. It is a free and very useful tool that can be downloaded from the browser extension web store. It contains a bunch of features that we will be listing and explaining them in a series of posts around the Level up extension In this post, we will see a brief summary about the Forms actions that can be done in the Level up for Dynamics 365/Power Apps . LOGICAL NAMES This option will show logical names for fields, tabs, web resources and sub-grids on the form CLEAR LOGICAL NAMES This option will remove the logical names of fields, tab...
Read more

DYNAMICS 365 REFERENCE PANEL

Image
Dynamics 365 product team is always working to improve and give the best user experience. Therefore, the continuous evolutions of the different areas and possibilities are one of the most critical things to bring. In this post, I will talk about one of these user experience improvements which is Reference Panel that was introduced with the Dynamics 365 V9. So what is exactly a Reference Panel? The Reference Panel is a type of section that can be added to the form that allows users to move across different types of sub grids and quick view controls in a single place without scrolling down or up. Let's take the example of the account form, where many quick view forms and sub grids exist inside (contacts, recent cases and opportunities...). When the users enter the form, they have to scroll up and down through the form in order to check the sub grids and their data which is sometimes annoying for them. ...
Read more