How to set the mediaReadLink and mediaEditLink of a stream property

XMLWordPrintable

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Major
    • V4.01_CS02
    • Affects Version/s: V4.01_CS01
    • Component/s: JSON Format, Protocol
    • None
    • Environment:

      Proposed

    • Hide

      Change last paragraph of JSON Format section "4.5.12 Control Information: media* (odata.media*)" from

      The media* control information is ignored in request payloads and not written in responses if metadata=none is requested.

      to

      The media* control information is not written in responses if metadata=none is requested.

      If a stream property is provided inline in a request, the mediaContentType control information may be specified.

      If a stream property is annotated with Capabilities.MediaLocationUpdateSupported and a value of true, clients MAY specify the mediaEditLink and/or mediaReadLink control information for that stream property in data modification requests to the structured type instance containing the stream property.

      In all other cases media* control information is ignored in request payloads.

      Add paragraph to Part 1: Protocol, section "11.4.8.1 Update Stream Values":

      Services MAY support changing the association between a stream property and a media stream by specifying the edit URL or read URL of the stream property in data modification requests to the structured type instance containing the stream property. Services SHOULD advertise this by annotating the stream property with the term Capabilities.MediaLocationUpdateSupported defined in [OData-VocCap].

      Show
      Change last paragraph of JSON Format section "4.5.12 Control Information: media* (odata.media*)" from The media* control information is ignored in request payloads and not written in responses if metadata=none is requested. to The media* control information is not written in responses if metadata=none is requested. If a stream property is provided inline in a request, the mediaContentType control information may be specified. If a stream property is annotated with Capabilities.MediaLocationUpdateSupported and a value of true , clients MAY specify the mediaEditLink and/or mediaReadLink  control information for that stream property in data modification requests to the structured type instance containing the stream property. In all other cases  media* control information is ignored in request payloads. Add paragraph to Part 1: Protocol, section "11.4.8.1 Update Stream Values": Services MAY support changing the association between a stream property and a media stream by specifying the edit URL or read URL of the stream property in data modification requests to the structured type instance containing the stream property. Services SHOULD advertise this by annotating the stream property with the term Capabilities.MediaLocationUpdateSupported defined in [OData-VocCap] .
    • Hide

      https://github.com/oasis-tcs/odata-vocabularies/pull/37/files
      https://www.oasis-open.org/committees/download.php/64795/odata-v4.01-wd06-part1-protocol-2019-03-01.docx
      https://www.oasis-open.org/committees/download.php/64796/odata-json-format-v4.01-wd06-2019-03-01.docx

      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/37/files https://www.oasis-open.org/committees/download.php/64795/odata-v4.01-wd06-part1-protocol-2019-03-01.docx https://www.oasis-open.org/committees/download.php/64796/odata-json-format-v4.01-wd06-2019-03-01.docx

      Stream properties allow the actual media to reside "somewhere else", redirecting clients to that location when directly addressing the stream property, and by including mediaReadLink and mediaEditLink in responses so clients can avoid the redirect from the canonical URL and directly access the media at its "non-canonical" location.

      How can clients specify a "non-canonical" location when creating an entity with stream properties?

      How can clients update the location of an existing stream property?

            Assignee:
            Unassigned
            Reporter:
            handl
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: