[OASIS Issue Tracker] (ODATA-1125) Define by-value/reference expectations for action/function payloads.

From
OASIS Issues Tracker <>
Date
2017-11-09T01:54:57+00:00
ID
Thread
[OASIS Issue Tracker] (ODATA-1125) Define by-value/reference expectations for action/function payloads.
[ https://issues.oasis-open.org/browse/ODATA-1125?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=68034#comment-68034 ] 

Michael Pizzo commented on ODATA-1125:
--------------------------------------

The representation of primitive, complex, and collection of primitive/complex types in function parameters is spelled out in [Protocol] section 11.5.2.1, Invoking a Function:

"Parameter values passed to functions MUST be specified either as a URL literal (for primitive typed values) or as a JSON formatted OData object (for complex typed values,  or collections of primitive or complex typed values)."

Added:
"Entity typed values are passed as JSON formatted entities that MAY include a subset of the properties, or just the entity reference, as appropriate to the function."

Representation of parameters for actions is covered in [JSON] section 18, Action Invocation:

"The value is the parameter value in the JSON representation appropriate for its type."

Added:

"Entity typed parameter values MAY include a subset of the properties, or just the entity reference, as appropriate to the action."

> Define by-value/reference expectations for action/function payloads.
> --------------------------------------------------------------------
>
>                 Key: ODATA-1125
>                 URL: https://issues.oasis-open.org/browse/ODATA-1125
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: Protocol
>    Affects Versions: V4.01_CSD03
>         Environment: Applied
>            Reporter: George Ericson
>            Assignee: Michael Pizzo
>             Fix For: V4.01_CS01
>
>
> Descriptions of parameters and return types do not explain expectations for references to Entities.  
> The metamodel + vocabulary for CSDL allows three types of encodings:
> •	By-reference, represented as a string containing a URL that references the resource.
> •	By-reference, represented as an object containing a partial copy of the resource  that includes just the @odata.id meta property with a value that is a string containing a URL that references the resource.
> •	By-value, represented as an object containing a copy of the resource.
> For parameters and return-types, the question is which of these are expected in a payload.



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)