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] (ODATA-809) Define non-message format for final response of async request


     [ https://issues.oasis-open.org/browse/ODATA-809?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Pizzo updated ODATA-809:
--------------------------------

    Environment: Simplified Payload, [Proposed]  (was: Simplified Payload)
       Proposal: 
Revised Proposal:
 -If client does not specify application/http, but does specify application/json, the final results are not wrapped. 
 -Add a new header, "OData-AsyncResult" (or "AysncResult"), whose value is the result code of the asynchronous operation and whose presence signals that the response has completed and the payload and headers represent the outcome of the asynchronous request. Services should always return this header value on the final result (whether wrapped or not).

  was:
Revised Proposal:
 -If client does not specify application/http, but does specify application/json, the final results are not wrapped. 
 -Add a new header, such as "OData-AsyncResult", whose value is the result code of the asynchronous operation and whose presence signals that the response has completed and the payload and headers represent the outcome of the asynchronous request. Services would always return this header value on the final result (whether wrapped or not).


> Define non-message format for final response of async request
> -------------------------------------------------------------
>
>                 Key: ODATA-809
>                 URL: https://issues.oasis-open.org/browse/ODATA-809
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData Protocol
>    Affects Versions: V4.0_ERRATA02
>         Environment: Simplified Payload, [Proposed]
>            Reporter: Michael Pizzo
>            Assignee: Michael Pizzo
>              Labels: AdoptionBlocker
>             Fix For: V4.01_WD01
>
>
> Today we define that, once an async result completes, polling the previously returned location header returns an HTTP-Message response that wraps the response (status, headers and body) that would have been returned if the request had processed synchronously:
> "A GET request to the status monitor resource returns 200 OK once the asynchronous processing has completed. This response MUST include a Content-Type header with value application/http and a Content-Transfer-Encoding header with value binary as described in [HTTP-Message]. The response body MUST enclose a single HTTP response which is the response to the initial Data Service Request."
> We did this in order to distinguish between the case that the request for status returned an error and the case where the response to the initial asynchronously request was an error.
> Everyone understands this once explained to them, but nobody likes it.
> Original proposal:
> Define a new json representation for an asynchronous response which is the response of the initial data service request, if successful. In this case the response headers are the headers that would have been returned had the response returned successfully. In the case that the asynchronously executing operation resulted in an error, define an error code and recommended message for "The asynchronous request resulted in an error." with an inner-error containing the status code and error text of the asynchronous operation.
> For backward compatibility, clients that specify an Accept Header of "application/http" would still get back the message format, but clients that don't specify an Accept Header that allows "application/http" but do specify "application/json" (with or without format parameters) for non-batch requests would get this JSON response instead of the response wrapped 



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


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