Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-798

Semantic Key or Alternate Key for entity types

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_ERRATA02
    • Fix Version/s: V4.01_WD01
    • Component/s: CSDL XML, URL Conventions
    • Labels:
    • Environment:

      New Query Capabilities

    • Proposal:
      Hide

      Adopt the following community vocabulary by adding the term to the OData Core vocabulary and describing the behavior in [URL Conventions]:
      https://github.com/OData/vocabularies/blob/master/OData.Community.Keys.V1.md
      https://github.com/OData/vocabularies/blob/master/OData.Community.Keys.V1.xml

      AppliesTo should be EntityType and EntiySet. NavigationProperty would be an exception, is somewhat implied by entity set, and AppliesTo does not prohibit other uses.

      Contact the existing community vocabulary owners to say that the term has been adopted by the OData Core vocabulary and should be used moving forward.

      Show
      Adopt the following community vocabulary by adding the term to the OData Core vocabulary and describing the behavior in [URL Conventions] : https://github.com/OData/vocabularies/blob/master/OData.Community.Keys.V1.md https://github.com/OData/vocabularies/blob/master/OData.Community.Keys.V1.xml AppliesTo should be EntityType and EntiySet. NavigationProperty would be an exception, is somewhat implied by entity set, and AppliesTo does not prohibit other uses. Contact the existing community vocabulary owners to say that the term has been adopted by the OData Core vocabulary and should be used moving forward.
    • Resolution:
      Hide

      https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/4.01%20spec/vocabularies/Org.OData.Core.V1.xml?op=diff&rev=943

      Show
      https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/4.01%20spec/vocabularies/Org.OData.Core.V1.xml?op=diff&rev=943

      Description

      Sometimes an entity type has a technical unique key, e.g. a sequence number or a guid, as well as one or more "semantic" or "alternate" keys, e.g. a User could be identified via a UserID or alternatively via an EmailAddress, or a Person could be identified via a Country+PassportNumber combination or a Country+SSN combination.

      These "semantic" or "alternate" keys may include nullable properties (you may not know a person's SSN, but if you know it, it identifies the person), and there could be more than one of them, each consisting of a different set of properties.

        Attachments

          Activity

            People

            • Assignee:
              handl Ralf Handl
              Reporter:
              handl Ralf Handl
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: