【免费】WCF的OData标准url-conventions资源-CSDN文库

odata

需积分: 0 153 浏览量 2014-08-22 12:11:03 上传评论收藏 552KB PDF 举报

资源推荐

资源详情

资源评论

odata-v4.0-os-part2-url-conventions 24 February 2014

OData Version 4.0 Part 2: URL

Conventions

OASIS Standard

24 February 2014

Specification URIs

This version:

http://docs.oasis-open.org/odata/odata/v4.0/os/part2-url-conventions/odata-v4.0-os-part2-url-

conventions.doc (Authoritative)

http://docs.oasis-open.org/odata/odata/v4.0/os/part2-url-conventions/odata-v4.0-os-part2-url-

conventions.html

http://docs.oasis-open.org/odata/odata/v4.0/os/part2-url-conventions/odata-v4.0-os-part2-url-

conventions.pdf

Previous version:

http://docs.oasis-open.org/odata/odata/v4.0/cs01/part2-url-conventions/odata-v4.0-cs01-part2-url-

conventions.doc (Authoritative)

http://docs.oasis-open.org/odata/odata/v4.0/cs01/part2-url-conventions/odata-v4.0-cs01-part2-url-

conventions.html

http://docs.oasis-open.org/odata/odata/v4.0/cs01/part2-url-conventions/odata-v4.0-cs01-part2-url-

conventions.pdf

Latest version:

http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.doc (Authoritative)

http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html

http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.pdf

Technical Committee:

OASIS Open Data Protocol (OData) TC

Chairs:

Barbara Hartel (barbara.hartel@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:

 OData Version 4.0 Part 1: Protocol. http://docs.oasis-open.org/odata/odata/v4.0/os/part1-

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

 OData Version 4.0 Part 2: URL Conventions (this document). http://docs.oasis-

open.org/odata/odata/v4.0/os/part2-url-conventions/odata-v4.0-os-part2-url-conventions.html.

 OData Version 4.0 Part 3: Common Schema Definition Language (CSDL). http://docs.oasis-

open.org/odata/odata/v4.0/os/part3-csdl/odata-v4.0-os-part3-csdl.html.

 ABNF components: OData ABNF Construction Rules Version 4.0 and OData ABNF Test

Cases. http://docs.oasis-open.org/odata/odata/v4.0/os/abnf/

odata-v4.0-os-part2-url-conventions 24 February 2014

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

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

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

open.org/odata/odata/v4.0/os/schemas/

 OData Metadata Service Entity Model: http://docs.oasis-

open.org/odata/odata/v4.0/os/models/MetadataService.edmx.

Related work:

This specification is related to:

 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 a data model, to be

published and edited by Web clients using simple HTTP messages. This specification defines a

set of recommended (but not required) rules for constructing URLs to identify the data and

metadata exposed by an OData service as well as a set of reserved URL query string operators.

Status:

This document was last revised or approved by the members of OASIS 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.

Technical Committee members should send comments on this specification to the Technical

Committee’s email list. Others should send comments to the Technical Committee by using the

“Send A Comment” button on the Technical Committee’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-Part2]

OData Version 4.0 Part 2: URL Conventions. Edited by Michael Pizzo, Ralf Handl, and Martin

Zurmuehl. 24 February 2014. OASIS Standard. http://docs.oasis-

open.org/odata/odata/v4.0/os/part2-url-conventions/odata-v4.0-os-part2-url-conventions.html.

Latest version: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html.

odata-v4.0-os-part2-url-conventions 24 February 2014

Notices

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-os-part2-url-conventions 24 February 2014

Table of Contents

1 Introduction ........................................................................................................................................... 7

1.1 Terminology ........................................................................................................................................ 7

1.2 Normative References ........................................................................................................................ 7

1.3 Typographical Conventions ................................................................................................................ 7

2 URL Components ................................................................................................................................. 9

3 Service Root URL ............................................................................................................................... 10

4 Resource Path .................................................................................................................................... 11

4.1 Addressing the Model for a Service .................................................................................................. 11

4.2 Addressing the Batch Endpoint for a Service ................................................................................... 11

4.3 Addressing Entities ........................................................................................................................... 11

4.3.1 Canonical URL .......................................................................................................................... 13

4.3.2 Canonical URL for Contained Entities ....................................................................................... 14

4.3.3 URLs for Related Entities with Referential Constraints ............................................................. 14

4.3.4 Resolving an Entity-Id ............................................................................................................... 14

4.4 Addressing References between Entities ......................................................................................... 14

4.5 Addressing Operations ..................................................................................................................... 15

4.5.1 Addressing Actions .................................................................................................................... 15

4.5.2 Addressing Functions ................................................................................................................ 15

4.6 Addressing a Property ...................................................................................................................... 16

4.7 Addressing a Property Value ............................................................................................................ 16

4.8 Addressing the Count of a Collection ............................................................................................... 16

4.9 Addressing Derived Types ................................................................................................................ 16

4.10 Addressing the Media Stream of a Media Entity ............................................................................ 17

4.11 Addressing the Cross Join of Entity Sets ....................................................................................... 17

4.12 Addressing All Entities in a Service ................................................................................................ 18

5 Query Options .................................................................................................................................... 19

5.1 System Query Options ...................................................................................................................... 19

5.1.1 System Query Option $filter ................................................................................................ 19

5.1.1.1 Logical Operators ............................................................................................................................... 19

5.1.1.1.1 Equals ........................................................................................................................................ 20

5.1.1.1.2 Not Equals.................................................................................................................................. 20

5.1.1.1.3 Greater Than .............................................................................................................................. 20

5.1.1.1.4 Greater Than or Equal ............................................................................................................... 20

5.1.1.1.5 Less Than .................................................................................................................................. 20

5.1.1.1.6 Less Than or Equal .................................................................................................................... 20

5.1.1.1.7 And ............................................................................................................................................. 20

5.1.1.1.8 Or ............................................................................................................................................... 20

5.1.1.1.9 Not ............................................................................................................................................. 20

5.1.1.1.10 has ......................................................................................................................................... 21

5.1.1.1.11 Logical Operator Examples ...................................................................................................... 21

5.1.1.2 Arithmetic Operators .......................................................................................................................... 21

5.1.1.2.1 Addition ...................................................................................................................................... 21

5.1.1.2.2 Subtraction ................................................................................................................................. 22

5.1.1.2.3 Negation ..................................................................................................................................... 22

odata-v4.0-os-part2-url-conventions 24 February 2014

5.1.1.2.4 Multiplication .............................................................................................................................. 22

5.1.1.2.5 Division....................................................................................................................................... 22

5.1.1.2.6 Modulo ....................................................................................................................................... 22

5.1.1.2.7 Arithmetic Operator Examples ................................................................................................... 22

5.1.1.3 Grouping ............................................................................................................................................ 23

5.1.1.4 Canonical Functions .......................................................................................................................... 23

5.1.1.4.1 contains ................................................................................................................................. 23

5.1.1.4.2 endswith ................................................................................................................................. 23

5.1.1.4.3 startswith ............................................................................................................................ 23

5.1.1.4.4 length ..................................................................................................................................... 24

5.1.1.4.5 indexof ................................................................................................................................... 24

5.1.1.4.6 substring ............................................................................................................................... 24

5.1.1.4.7 tolower ................................................................................................................................... 24

5.1.1.4.8 toupper ................................................................................................................................... 25

5.1.1.4.9 trim ......................................................................................................................................... 25

5.1.1.4.10 concat ................................................................................................................................... 25

5.1.1.4.11 year ....................................................................................................................................... 25

5.1.1.4.12 month ..................................................................................................................................... 26

5.1.1.4.13 day ......................................................................................................................................... 26

5.1.1.4.14 hour ....................................................................................................................................... 26

5.1.1.4.15 minute ................................................................................................................................... 27

5.1.1.4.16 second ................................................................................................................................... 27

5.1.1.4.17 fractionalseconds ........................................................................................................... 27

5.1.1.4.18 date ....................................................................................................................................... 27

5.1.1.4.19 time ....................................................................................................................................... 27

5.1.1.4.20 totaloffsetminutes ......................................................................................................... 28

5.1.1.4.21 now ......................................................................................................................................... 28

5.1.1.4.22 maxdatetime ........................................................................................................................ 28

5.1.1.4.23 mindatetime ........................................................................................................................ 28

5.1.1.4.24 totalseconds ...................................................................................................................... 28

5.1.1.4.25 round ..................................................................................................................................... 28

5.1.1.4.26 floor ..................................................................................................................................... 29

5.1.1.4.27 ceiling ................................................................................................................................. 29

5.1.1.4.28 isof ....................................................................................................................................... 29

5.1.1.4.29 cast ....................................................................................................................................... 29

5.1.1.4.30 geo.distance ...................................................................................................................... 30

5.1.1.4.31 geo.intersects .................................................................................................................. 30

5.1.1.4.32 geo.length .......................................................................................................................... 30

5.1.1.5 Lambda Operators ............................................................................................................................. 31

5.1.1.5.1 any ........................................................................................................................................... 31

5.1.1.5.2 all ........................................................................................................................................... 31

5.1.1.6 Literals ............................................................................................................................................... 31

5.1.1.6.1 Primitive Literals ......................................................................................................................... 31

5.1.1.6.2 Complex and Collection Literals ................................................................................................. 31

5.1.1.6.3 null ......................................................................................................................................... 32

5.1.1.6.4 $it ........................................................................................................................................... 32

5.1.1.6.5 $root ....................................................................................................................................... 32