Skip to content
No description, website, or topics provided.
C#
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
CSharp Web API Controller.cs
DataServiceComponentTemplateSwagger.json
README.md

README.md

Ally-DataServiceComponent-Template

This template allows the implementation of a CRM system as a DataServiceComponent usable by Ally for retrieving and updating Entities with the help of an EntityMapping from DataServiceComponent Entities to Ally Entities.

Implementation of this Template for the Microsoft Dynamics 365 CRM system: https://github.com/AliruJulian/Ally-DataServiceComponent-D365

API Descriptions:

  • MetadataController/Entities: Returns a list of all Entities with logical names attached present in the DataServiceComponent. The purpose of this is to be able to create the Mapping from DataServiceComponent Entities to Ally Entities.
    • Input (DataServiceComponentMetadataEntitiesRequest):
      • Guid UserID: Allows for access to the DataServiceComponent.
    • Output (DataServiceComponentMetadataEntitiesResponse):
      • List Entities: All Entities with Name and LogicalName attached.
  • MetadataController/EntityFields:
    • Input (DataServiceComponentMetadataEntityFieldsRequest):
      • Guid UserID: Allows for access to the DataServiceComponent.
      • String EntityLogicalName: Specifies which Entity the returning EntityFields belong to.
    • Output (DataServiceComponentMetadataEntityFieldsResponse):
      • List EntityFields: All EntityFields with Name, LogicalName, and EntityFieldType Type attached.
  • GetController/GetFunction:
    • Input (DataServiceComponentGetRequest):
      • Guid UserID: Allows for access to the DataServiceComponent.
      • String EntityLogicalName: Logical name of the Entity type the returning Entities must have.
      • FilterRequestBody FilterRequest: Name and Value of a FilterRequest to constrain the returning Entities.
      • List EntityFields: List of Logical Names of the EntityFields included with the returning Entities.
    • Output (DataServiceComponentGetResponse):
      • List Entities: The returning List of DataEntity with only the specified EntityFields.
  • SetController/SetFunction:
    • Input (DataServiceComponentSetRequest):
      • Guid UserID: Allows for access to the DataServiceComponent.
      • List Entities: List of DataEntity containing the Entities which are set to be updated in the DataServiceComponent. Not all EntityFields have to be set.
    • Output (HttpResponseMessage)
You can’t perform that action at this time.