OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

odata message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: [OASIS Issue Tracker] Commented: (ODATA-398) Define canonical function as a path segment that allows retrieving an entity by its id


    [ http://tools.oasis-open.org/issues/browse/ODATA-398?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=33575#action_33575 ] 

Ralf Handl commented on ODATA-398:
----------------------------------

Just noticed that we talk about "Resource References" in Protocol, Atom, and JSON, and allow referencing to properties of entities, but all examples we have are only about "entity references".

So I removed "resource reference" and replaced its occurrences with "entity reference".

> Define canonical function as a path segment that allows retrieving an entity by its id
> --------------------------------------------------------------------------------------
>
>                 Key: ODATA-398
>                 URL: http://tools.oasis-open.org/issues/browse/ODATA-398
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: OData ABNF Construction Rules, OData Protocol , OData URL Conventions 
>    Affects Versions: V4.0_CSD01
>         Environment: [Applied]
>            Reporter: Michael Pizzo
>            Assignee: Ralf Handl
>             Fix For: V4.0_CSD02
>
>
> Ids are the primary way to reference an instance in OData; they are used in relationships, in deltas, and can take the place of instances in payloads. We recommend, but do not require that ids be dereferenceable.
> Clients need a dependable way to get from an id to a reference, whether or not the reference is dereferencable. Although they could construct a query if they know the root set the id comes from, it would be useful and more discoverable to introduce a canonical query function, at the service root, for returning an instance given its id.
> Note that, since the id is likely to contain illegal characters, we have to pass the id as a query option, and will need to double single quotes in reference
> Options:
> GET ~myservice/getbyid(@id)?@id='.....'
> GET ~myservice/$getbyid?@id='.....'

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]