Information technology — Open data protocol (OData) v4.0 — Part 1: Core

ISO/IEC 20802-1:2016 defines the core semantics and facilities of the Open Data Protocol (OData). This enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Locators (URLs) and defined in an Entity Data Model (EDM), to be published and edited by Web clients using simple HTTP messages.

Technologies de l'information — Protocole de données ouvertes (OData) v4.0 — Partie 1: Base

General Information

Status
Published
Publication Date
14-Dec-2016
Current Stage
9020 - International Standard under periodical review
Start Date
15-Oct-2021
Ref Project

Buy Standard

Standard
ISO/IEC 20802-1:2016 - Information technology -- Open data protocol (OData) v4.0
English language
203 pages
sale 15% off
Preview
sale 15% off
Preview

Standards Content (sample)

INTERNATIONAL ISO/IEC
STANDARD 20802-1
First edition
2016-12-15
Information technology — Open data
protocol (OData) v4.0
Part 1:
Core
Technologies de l'information — Protocole de données ouvertes
(OData) v4.0 —
Partie 2: Base
Reference number
ISO/IEC 20802-1:2016(E)
ISO/IEC 2016
---------------------- Page: 1 ----------------------
ISO/IEC 20802-1:2016(E)
COPYRIGHT PROTECTED DOCUMENT
© ISO/IEC 2016

All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form or by any

means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission.

Permission can be requested from either ISO at the address below or ISO’s member body in the country of the requester.

ISO copyright office
Ch. de Blandonnet 8 • CP 401
CH-1214 Vernier, Geneva, Switzerland
Tel. +41 22 749 01 11
Fax +41 22 749 09 47
copyright@iso.org
www.iso.org
ii © ISO/IEC 2016 – All rights reserved
---------------------- Page: 2 ----------------------
ISO/IEC 20802-1:2016(E)
Foreword

ISO (the International Organization for Standardization) and IEC (the International Electrotechnical

Commission) form the specialized system for worldwide standardization. National bodies that are

members of ISO or IEC participate in the development of International Standards through technical

committees established by the respective organization to deal with particular fields of technical activity.

ISO and IEC technical committees collaborate in fields of mutual interest. Other international

organizations, governmental and non‐governmental, in liaison with ISO and IEC, also take part in the

work. In the field of information technology, ISO and IEC have established a joint technical committee,

ISO/IEC JTC 1.

The procedures used to develop this document and those intended for its further maintenance are

described in the ISO/IEC Directives, Part 1. In particular the different approval criteria needed for the

different types of document should be noted. This document was drafted in accordance with the

editorial rules of the ISO/IEC Directives, Part 2 (see www.iso.org/directives).

Attention is drawn to the possibility that some of the elements of this document may be the subject of

patent rights. ISO and IEC shall not be held responsible for identifying any or all such patent rights.

Details of any patent rights identified during the development of the document will be in the

Introduction and/or on the ISO list of patent declarations received (see www.iso.org/patents).

Any trade name used in this document is information given for the convenience of users and does not

constitute an endorsement.

For an explanation on the meaning of ISO specific terms and expressions related to conformity

assessment, as well as information about ISO's adherence to the WTO principles in the Technical

Barriers to Trade (TBT) see the following URL: www.iso.org/iso/foreword.html.

ISO/IEC 20802‐1 was prepared by OASIS and was adopted, under the PAS procedure, by Joint Technical

Committee ISO/IEC JTC 1, Information technology, in parallel with its approval by the national bodies of

ISO and IEC.
© ISO/IEC 2016 – All rights reserved iii
---------------------- Page: 3 ----------------------
ISO/IEC 20802-1:2016(E)
OData Version 4.0 Part 1: Protocol Plus
Errata 02
OASIS Standard incorporating Approved Errata 02
30 October 2014
Specification URIs
This version:

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part1-protocol/odata-v4.0-

errata02-os-part1-protocol-complete.doc (Authoritative)

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part1-protocol/odata-v4.0-

errata02-os-part1-protocol-complete.html

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part1-protocol/odata-v4.0-

errata02-os-part1-protocol-complete.pdf
Previous version:

http://docs.oasis-open.org/odata/odata/v4.0/errata01/os/complete/part1-protocol/odata-v4.0-

errata01-os-part1-protocol-complete.doc (Authoritative)

http://docs.oasis-open.org/odata/odata/v4.0/errata01/os/complete/part1-protocol/odata-v4.0-

errata01-os-part1-protocol-complete.html

http://docs.oasis-open.org/odata/odata/v4.0/errata01/os/complete/part1-protocol/odata-v4.0-

errata01-os-part1-protocol-complete.pdf
Latest version:

http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.doc (Authoritative)

http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html
http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.pdf
Technical Committee:
OASIS Open Data Protocol (OData) TC
Chairs:
Ralf Handl (ralf.handl@sap.com), SAP AG
Ram Jeyaraman (Ram.Jeyaraman@microsoft.com), Microsoft
Editors:
Michael Pizzo (mikep@microsoft.com), Microsoft
Ralf Handl (ralf.handl@sap.com), SAP AG
Martin Zurmuehl (martin.zurmuehl@sap.com), SAP AG
Additional artifacts:
This prose specification is one component of a Work Product that also includes:

 List of Errata items. OData Version 4.0 Errata 02. Edited by Michael Pizzo, Ralf Handl, Martin

Zurmuehl, and Hubert Heijkers. 30 October 2014. OASIS Approved Errata. http://docs.oasis-

open.org/odata/odata/v4.0/errata02/os/odata-v4.0-errata02-os.html.

 OData Version 4.0 Part 1: Protocol Plus Errata 02 (this document). Edited by Michael Pizzo,

Ralf Handl, and Martin Zurmuehl. 30 October 2014. OASIS Standard incorporating Approved

Errata 02. http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part1-

protocol/odata-v4.0-errata02-os-part1-protocol-complete.html.

 OData Version 4.0 Part 2: URL Conventions Plus Errata 02. Edited by Michael Pizzo, Ralf

Handl, and Martin Zurmuehl. 30 October 2014. OASIS Standard incorporating Approved

odata-v4.0-errata02-os-part1-protocol-complete 30 October 2014

Standards Track Work Product Copyright © OASIS Open 2014. All Rights Reserved. Page 1 of 74

© ISO/IEC 2016 – All rights reserved
---------------------- Page: 4 ----------------------
ISO/IEC 20802-1:2016(E)

Errata 02. http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-

conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.html.

 OData Version 4.0 Part 3: Common Schema Definition Language (CSDL) Plus Errata 02.

Edited by Michael Pizzo, Ralf Handl, and Martin Zurmuehl. 30 October 2014. OASIS
Standard incorporating Approved Errata 02. http://docs.oasis-

open.org/odata/odata/v4.0/errata02/os/complete/part3-csdl/odata-v4.0-errata02-os-part3-

csdl-complete.html.
 ABNF components: OData ABNF Construction Rules Version 4.0 and OData ABNF Test
Cases. http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/abnf/.

 Vocabulary components: OData Core Vocabulary, OData Measures Vocabulary and OData

Capabilities Vocabulary. http://docs.oasis-
open.org/odata/odata/v4.0/errata02/os/complete/vocabularies/.

 XML schemas: OData EDMX XML Schema and OData EDM XML Schema. http://docs.oasis-

open.org/odata/odata/v4.0/errata02/os/complete/schemas/.
 OData Metadata Service Entity Model: http://docs.oasis-
open.org/odata/odata/v4.0/errata02/os/complete/models/.

 Change-marked (redlined) versions of OData Version 4.0 Part 1, Part 2, and Part 3. OASIS

Standard incorporating Approved Errata 02. http://docs.oasis-
open.org/odata/odata/v4.0/errata02/os/redlined/.
Related work:
This specification is related to:

 OData Version 4.0 Part 1: Protocol. Edited by Michael Pizzo, Ralf Handl, and Martin

Zurmuehl. 24 February 2014. OASIS Standard. http://docs.oasis-
open.org/odata/odata/v4.0/os/part1-protocol/odata-v4.0-os-part1-protocol.html.

 OData Atom Format Version 4.0. Edited by Martin Zurmuehl, Michael Pizzo, and Ralf Handl.

Latest version. http://docs.oasis-open.org/odata/odata-atom-format/v4.0/odata-atom-format-

v4.0.html.

 OData JSON Format Version 4.0. Edited by Ralf Handl, Michael Pizzo, and Mark Biamonte.

Latest version. http://docs.oasis-open.org/odata/odata-json-format/v4.0/odata-json-format-

v4.0.html.
Declared XML namespaces:
 http://docs.oasis-open.org/odata/ns/edmx
 http://docs.oasis-open.org/odata/ns/edm
Abstract:

The Open Data Protocol (OData) enables the creation of REST-based data services, which allow

resources, identified using Uniform Resource Locators (URLs) and defined in an Entity Data

Model (EDM), to be published and edited by Web clients using simple HTTP messages. This

document defines the core semantics and facilities of the protocol.
Status:

This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on

the above date. The level of approval is also listed above. Check the “Latest version” location

noted above for possible later revisions of this document. Any other numbered Versions and

other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-

open.org/committees/tc_home.php?wg_abbrev=odata#technical.

TC members should send comments on this specification to the TC’s email list. Others should

send comments to the TC’s public comment list, after subscribing to it by following the

instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-

open.org/committees/odata/.

For information on whether any patents have been disclosed that may be essential to

implementing this specification, and any offers of patent licensing terms, please refer to the

Intellectual Property Rights section of the Technical Committee web page (https://www.oasis-

open.org/committees/odata/ipr.php).
Citation format:

When referencing this specification the following citation format should be used:

odata-v4.0-errata02-os-part1-protocol-complete 30 October 2014

Standards Track Work Product Copyright © OASIS Open 2014. All Rights Reserved. Page 2 of 74

© ISO/IEC 2016 – All rights reserved
---------------------- Page: 5 ----------------------
ISO/IEC 20802-1:2016(E)
[OData-Part1]

OData Version 4.0 Part 1: Protocol Plus Errata 02. Edited by Michael Pizzo, Ralf Handl, and

Martin Zurmuehl. 30 October 2014. OASIS Standard incorporating Approved Errata 02.

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part1-protocol/odata-v4.0-

errata02-os-part1-protocol-complete.html. Latest version: http://docs.oasis-
open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html.
odata-v4.0-errata02-os-part1-protocol-complete 30 October 2014

Standards Track Work Product Copyright © OASIS Open 2014. All Rights Reserved. Page 3 of 74

© ISO/IEC 2016 – All rights reserved
---------------------- Page: 6 ----------------------
ISO/IEC 20802-1:2016(E)
Notices
Copyright © OASIS Open 2014. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual

Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that

comment on or otherwise explain it or assist in its implementation may be prepared, copied, published,

and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice

and this section are included on all such copies and derivative works. However, this document itself may

not be modified in any way, including by removing the copyright notice or references to OASIS, except as

needed for the purpose of developing any document or deliverable produced by an OASIS Technical

Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must

be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors

or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS

DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY
WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would

necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard,

to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to

such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that

produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of

any patent claims that would necessarily be infringed by implementations of this specification by a patent

holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR

Mode of the OASIS Technical Committee that produced this specification. OASIS may include such

claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that

might be claimed to pertain to the implementation or use of the technology described in this document or

the extent to which any license under such rights might or might not be available; neither does it

represent that it has made any effort to identify any such rights. Information on OASIS' procedures with

respect to rights in any document or deliverable produced by an OASIS Technical Committee can be

found on the OASIS website. Copies of claims of rights made available for publication and any

assurances of licenses to be made available, or the result of an attempt made to obtain a general license

or permission for the use of such proprietary rights by implementers or users of this OASIS Committee

Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no

representation that any information or list of intellectual property rights will at any time be complete, or

that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be

used only to refer to the organization and its official outputs. OASIS welcomes reference to, and

implementation and use of, specifications, while reserving the right to enforce its marks against

misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above

guidance.
odata-v4.0-errata02-os-part1-protocol-complete 30 October 2014

Standards Track Work Product Copyright © OASIS Open 2014. All Rights Reserved. Page 4 of 74

© ISO/IEC 2016 – All rights reserved
---------------------- Page: 7 ----------------------
ISO/IEC 20802-1:2016(E)
Table of Contents

1 Introduction ......................................................................................................................................... 10

1.1 Terminology ...................................................................................................................................... 10

1.2 Normative References ...................................................................................................................... 10

1.3 Typographical Conventions .............................................................................................................. 11

2 Overview ............................................................................................................................................. 12

3 Data Model ......................................................................................................................................... 13

3.1 Annotations ....................................................................................................................................... 13

4 Service Model ..................................................................................................................................... 15

4.1 Entity-Ids and Entity References ...................................................................................................... 15

4.2 Read URLs and Edit URLs ............................................................................................................... 15

4.3 Transient Entities .............................................................................................................................. 15

5 Versioning ........................................................................................................................................... 16

5.1 Protocol Versioning ........................................................................................................................... 16

5.2 Model Versioning .............................................................................................................................. 16

6 Extensibility ......................................................................................................................................... 17

6.1 Query Option Extensibility ................................................................................................................ 17

6.2 Payload Extensibility ......................................................................................................................... 17

6.3 Action/Function Extensibility ............................................................................................................. 17

6.4 Vocabulary Extensibility .................................................................................................................... 17

6.5 Header Field Extensibility ................................................................................................................. 18

6.6 Format Extensibility .......................................................................................................................... 18

7 Formats .............................................................................................................................................. 19

8 Header Fields ..................................................................................................................................... 20

8.1 Common Headers ............................................................................................................................. 20

8.1.1 Header Content-Type ............................................................................................................ 20

8.1.2 Header Content-Encoding ................................................................................................... 20

8.1.3 Header Content-Language ................................................................................................... 20

8.1.4 Header Content-Length ....................................................................................................... 20

8.1.5 Header OData-Version.......................................................................................................... 20

8.2 Request Headers .............................................................................................................................. 21

8.2.1 Header Accept ......................................................................................................................... 21

8.2.2 Header Accept-Charset ....................................................................................................... 21

8.2.3 Header Accept-Language ..................................................................................................... 21

8.2.4 Header If-Match .................................................................................................................... 21

8.2.5 Header If-None-Match.......................................................................................................... 21

8.2.6 Header OData-Isolation ..................................................................................................... 22

8.2.7 Header OData-MaxVersion ................................................................................................... 22

8.2.8 Header Prefer ......................................................................................................................... 22

8.2.8.1 Preference odata.allow-entityreferences ............................................................................ 23

8.2.8.2 Preference odata.callback .......................................................................................................... 23

8.2.8.3 Preference odata.continue-on-error ....................................................................................... 24

8.2.8.4 Preference odata.include-annotations ................................................................................... 24

odata-v4.0-errata02-os-part1-protocol-complete 30 October 2014

Standards Track Work Product Copyright © OASIS Open 2014. All Rights Reserved. Page 5 of 74

© ISO/IEC 2016 – All rights reserved
---------------------- Page: 8 ----------------------
ISO/IEC 20802-1:2016(E)

8.2.8.5 Preference odata.maxpagesize .................................................................................................... 25

8.2.8.6 Preference odata.track-changes ................................................................................................ 25

8.2.8.7 Preference return=representation and return=minimal ..................................................... 25

8.2.8.8 Preference respond-async ............................................................................................................ 26

8.2.8.9 Preference wait ................................................................................................................................ 26

8.3 Response Headers ........................................................................................................................... 26

8.3.1 Header ETag ............................................................................................................................. 26

8.3.2 Header Location .................................................................................................................... 27

8.3.3 Header OData-EntityId ....................................................................................................... 27

8.3.4 Header Preference-Applied ............................................................................................... 27

8.3.5 Header Retry-After .............................................................................................................. 27

9 Common Response Status Codes ..................................................................................................... 28

9.1 Success Responses ......................................................................................................................... 28

9.1.1 Response Code 200 OK ......................................................................................................... 28

9.1.2 Response Code 201 Created ............................................................................................... 28

9.1.3 Response Code 202 Accepted ............................................................................................ 28

9.1.4 Response Code 204 No Content ........................................................................................ 28

9.1.5 Response Code 3xx Redirection ...................................................................................... 28

9.1.6 Response Code 304 Not Modified .................................................................................... 28

9.2 Client Error Responses ..................................................................................................................... 29

9.2.1 Response Code 404 Not Found .......................................................................................... 29

9.2.2 Response Code 405 Method Not Allowed ....................................................................... 29

9.2.3 Response Code 410 Gone ...................................................................................................... 29

9.2.4 Response Code 412 Precondition Failed ...................................................................... 29

9.3 Server Error Responses ................................................................................................................... 29

9.3.1 Response Code 501 Not Implemented ............................................................................. 29

9.4 In-Stream Errors ............................................................................................................................... 29

10 Context URL ....................................................................................................................................... 30

10.1 Service Document .......................................................................................................................... 30

10.2 Collection of Entities ....................................................................................................................... 30

10.3 Entity ............................................................................................................................................... 31

10.4 Singleton ......................................................................................................................................... 31

10.5 Collection of Derived Entities .......................................................................................................... 31

10.6 Derived Entity ................................................................................................................................. 32

10.7 Collection of Projected Entities ....................................................................................................... 32

10.8 Projected Entity ............................................................................................................................... 32

10.9 Collection of Projected Expanded Entities ...................................................................................... 33

10.10 Projected Expanded Entity ........................................................................................................... 33

10.11 Collection of Entity References .................................................................................................... 33

10.12 Entity Reference ........................................................................................................................... 34

10.13 Property Value .............................................................................................................................. 34

10.14 Collection of Complex or Primitive Types ..................................................................................... 34

10.15 Complex or Primitive Type ............................................................................................................ 34

10.16 Operation Result ........................................................................................................................... 34

odata-v4.0-errata02-os-part1-protocol-complete 30 October 2014

Standards Track Work Product Copyright © OASIS Open 2014. All Rights Reserved. Page 6 of 74

© ISO/IEC 2016 – All rights reserved
---------------------- Page: 9 ----------------------
ISO/IEC 20802-1:2016(E)

10.17 Delta Response ............................................................................................................................ 35

10.18 Item in a Delta Response ............................................................................................................. 35

10.19 $all Response ........................................................................................................................... 35

10.20 $crossjoin Response .............................................................................................................. 35

11 Data Service Requests ....................................................................................................................... 36

11.1 Metadata Requests ......................................................................................................................... 36

11.1.1 Service Document Request ..................................................................................................... 36

11.1.2 Metadata Document Request.................................................................................................. 36

11.1.3 Metadata Service Document Request .................................................................................... 36

11.2 Requesting Data ............................................................................................................................. 36

11.2.1 Evaluating System Query Options .......................................................................................... 37

11.2.2 Requesting Individual Entities ................................................................................................. 37

11.2.3 Requesting Individual Properties ............................................................................................ 37

11.2.3.1 Requesting a Property's Raw Value using $value ......................................................................... 38

11.2.4 Specifying Properties to Return .............................................................................................. 38

11.2.4.1 System Query Option $s
...

Questions, Comments and Discussion

Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.