Open Data Protocol


In computing, Open Data Protocol is an open protocol which allows the creation and consumption of queryable and interoperable REST APIs in a simple and standard way. Microsoft initiated OData in 2007. Versions 1.0, 2.0, and 3.0 are released under the Microsoft Open Specification Promise. Version 4.0 was standardized at OASIS, with a release in March 2014. In April 2015 OASIS submitted OData v4 and OData JSON Format v4 to ISO/IEC JTC 1 for approval as an international standard.
The protocol enables the creation and consumption of REST APIs, which allow Web clients to publish and edit resources, identified using URLs and defined in a data model, using simple HTTP messages. OData shares some similarities with JDBC and with ODBC; like ODBC, OData is not limited to relational databases.

Standardization

After initial development by Microsoft, OData became a standardized protocol of the OASIS OData Technical Committee.

OASIS OData Technical Committee

"The OASIS OData TC works to simplify the querying and sharing of data across disparate applications and multiple stakeholders for re-use in the enterprise, Cloud, and mobile devices. A REST-based protocol, OData builds on HTTP, AtomPub, and JSON using URIs to address and access data feed resources. It enables information to be accessed from a variety of sources including relational databases, file systems, content management systems, and traditional Web sites. OData provides a way to break down data silos and increase the shared value of data by creating an ecosystem in which data consumers can interoperate with data producers in a way that is far more powerful than currently possible, enabling more applications to make sense of a broader set of data. Every producer and consumer of data that participates in this ecosystem increases its overall value."

TC participants include CA Technologies, Citrix Systems, IBM, Microsoft, Progress Software, Red Hat, SAP SE and SDL.

Architecture

OData is a protocol for the creation and consumption of RESTful APIs. Thus, as common practices of REST, OData builds on HTTP, AtomPub, and JSON using URIs to address and access data feed resources.

Resource identification

OData uses URIs to identify resources. For every OData service whose service root is abbreviated as http://host/service/, the following fixed resources can be found:

The service document

The service document lists entity sets, functions, and singletons that can be retrieved. Clients can use the service document to navigate the model in a hypermedia-driven fashion.
The service document is available at http://host/service/.

The metadata document

The metadata document describes the types, sets, functions and actions understood by the OData service. Clients can use the metadata document to understand how to query and interact with entities in the service.
The metadata document is available at http://host/service/$metadata.

Dynamic resources

The URIs for the dynamic resources may be computed from the hypermedia information in the service document and metadata document.

Resource operation

OData uses the HTTP verbs to indicate the operations on the resources.
OData uses different formats for representing data and the data model. In OData protocol version 4.0, JSON format is the standard for representing data, with the Atom format still being in committee specification stage. For representing the data model, the Common Schema Definition Language is used, which defines an XML representation of the entity data model exposed by OData services.

A sample OData JSON data payload

A collection of products:

A sample OData Atom data payload

A collection of products:


http://services.odata.org/v4/odata/odata.svc/Products
Products
2015-05-19T03:38:50Z


http://services.odata.org/V4/OData/OData.svc/Products








<br> <updated>2015-05-19T03:38:50Z</updated><br> <author><br> <name/><br> </author><br> <content type="application/xml"><br> <m:properties><br> <d:ID m:type="Int32">0</d:ID><br> <d:Name>Bread</d:Name><br> <d:Description><a href="/wiki/Whole_grain">Whole grain</a> bread</d:Description><br> <d:ReleaseDate m:type="DateTimeOffset">1992-01-01T00:00:00Z</d:ReleaseDate><br> <d:DiscontinuedDate m:null="true"/><br> <d:Rating m:type="Int16">4</d:Rating><br> <d:Price m:type="Double">2.5</d:Price><br> </m:properties><br> </content><br> </entry><br> <entry><br> <id>http://services.odata.org/V4/OData/OData.svc/Products</id><br> <category term="#ODataDemo.Product" scheme="http://docs.oasis-open.org/odata/ns/scheme"/><br> <link rel="edit" title="Product" href="Products"/><br> <link rel="http://docs.oasis-open.org/odata/ns/relatedlinks/Categories" type="application/xml" title="Categories" href="Products/Categories/$ref"/><br> <link rel="http://docs.oasis-open.org/odata/ns/related/Categories" type="application/atom+xml;type=feed" title="Categories" href="Products/Categories"/><br> <link rel="http://docs.oasis-open.org/odata/ns/relatedlinks/Supplier" type="application/xml" title="Supplier" href="Products/Supplier/$ref"/><br> <link rel="http://docs.oasis-open.org/odata/ns/related/Supplier" type="application/atom+xml;type=entry" title="Supplier" href="Products/Supplier"/><br> <link rel="http://docs.oasis-open.org/odata/ns/relatedlinks/ProductDetail" type="application/xml" title="ProductDetail" href="Products/ProductDetail/$ref"/><br> <link rel="http://docs.oasis-open.org/odata/ns/related/ProductDetail" type="application/atom+xml;type=entry" title="ProductDetail" href="Products/ProductDetail"/><br> <title/><br> <updated>2015-05-19T03:38:50Z</updated><br> <author><br> <name/><br> </author><br> <content type="application/xml"><br> <m:properties><br> <d:ID m:type="Int32">1</d:ID><br> <d:Name>Milk</d:Name><br> <d:Description>Low fat milk</d:Description><br> <d:ReleaseDate m:type="DateTimeOffset">1995-10-01T00:00:00Z</d:ReleaseDate><br> <d:DiscontinuedDate m:null="true"/><br> <d:Rating m:type="Int16">3</d:Rating><br> <d:Price m:type="Double">3.5</d:Price><br> </m:properties><br> </content><br> </entry><br> ...<br></feed><br></syntaxhighlight><h4>A sample OData metadata document</h4><syntaxhighlight lang="xml" enclose="div" line><br><edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx"><br> <edmx:DataServices><br> <Schema Namespace="ODataDemo" xmlns="http://docs.oasis-open.org/odata/ns/edm"><br> <EntityType Name="Product"><br> <Key><br> <PropertyRef Name="ID"/><br> </Key><br> <Property Name="ID" Type="Edm.Int32" Nullable="false"/><br> <Property Name="Name" Type="Edm.String"/><br> <Property Name="Description" Type="Edm.String"/><br> <Property Name="ReleaseDate" Type="Edm.DateTimeOffset" Nullable="false"/><br> <Property Name="DiscontinuedDate" Type="Edm.DateTimeOffset"/><br> <Property Name="Rating" Type="Edm.Int16" Nullable="false"/><br> <Property Name="Price" Type="Edm.Double" Nullable="false"/><br> </EntityType><br> <ComplexType Name="Address"><br> <Property Name="Street" Type="Edm.String"/><br> <Property Name="City" Type="Edm.String"/><br> <Property Name="State" Type="Edm.String"/><br> <Property Name="ZipCode" Type="Edm.String"/><br> <Property Name="Country" Type="Edm.String"/><br> </ComplexType><br> <br> <EntityContainer Name="DemoService"><br> <EntitySet Name="Products" EntityType="ODataDemo.Product"></EntitySet><br> </EntityContainer><br> </Schema><br> </edmx:DataServices><br></edmx:Edmx><br></syntaxhighlight><h2>Ecosystem</h2>The ecosystem of OData consists of the client/server libraries that implement the protocol, and applications that are based on the protocol.<h3>Libraries</h3>There are a number of OData libraries available to access/produce OData APIs:<h4>.NET</h4><ul><li> Server and client: </li><li> Client: <h4>Java</h4></li><li> Server and client: </li><li> Server side: </li><li> Client: <h4>JavaScript</h4></li><li> Client: </li><li> Client: </li><li> Client: for higher <a href="/wiki/Level_of_abstraction">level of abstraction</a>. </li><li> Client: <a href="/wiki/OpenUI5">OpenUI5</a> library maintained by SAP</li><li> Client : </li><li> Client: </li><li> Client: </li><li> Server: <h4>PHP</h4></li><li> Client: </li><li> Server: <h4>Python</h4></li><li> Client: </li><li> Server and client: <h4>Ruby</h4></li><li> Client: </li><li> Client: </li><li> Server: <h4>Others</h4></li></ul>Other languages implemented include:<br><ul><li> AJAX: the for getting to OData.</li><li> C++: is a client-side-only implementation of the OData protocol.</li><li> supports OData in their Reporting & Document Generation Solutions.</li><li> Reporting tool <a href="/wiki/List_%26_Label">List & Label</a> has a specialized data provider for OData.</li><li> Blackberry : Open Data Protocol library for BlackBerry 10 Cascades apps<h3>Applications</h3></li></ul>Applications include:<br><ul><li> can expose any cloud, big data or relational data sources as OData end points</li><li> <a href="/wiki/Socrata">Socrata</a> exposes an OData <a href="/wiki/API">API</a>.</li><li> <a href="/wiki/Microsoft_Azure">Microsoft Azure</a> exposes an OData API.</li><li> <a href="/wiki/SAP_NetWeaver">SAP NetWeaver</a> Gateway provides OData access to <a href="/wiki/SAP_Business_Suite">SAP Business Suite</a> and SAP Business Warehouse.</li><li> <a href="/wiki/IBM_WebSphere_eXtreme_Scale">IBM WebSphere eXtreme Scale</a> REST data service can be accessed by any <a href="/wiki/HTTP_client">HTTP client</a> using oData.</li><li> <a href="/wiki/Microsoft_SharePoint_2010">Microsoft SharePoint 2010</a> and up can expose its data as OData endpoint</li><li> <a href="/wiki/Office_365">Office 365</a> exposes OData V4.0 APIs.</li><li> <a href="/wiki/Salesforce.com">Salesforce</a> Lightning Connect consumes OData APIs.</li><li> exposes cloud and database data via OData</li><li> <a href="/wiki/Tableau_Software">Tableau</a> can connect to OData APIs.</li><li>TIBCO Spotfire can connect to OData APIs.</li><li> helps integrate with OData APIs.</li><li> uses Odata APIs</li><li> uses Odata </li><li>Redfish uses Odata<h2>Tools</h2></li><li> Nucleon <a href="/wiki/Database_Master">Database Master</a><h3>OData OASIS Standards</h3></li><li> </li><li> </li><li> </li><li> </li><li> </li><li> </li><li> <h3>Committee Specifications</h3></li><li> </li><li> </li></ul> </section> <aside> <h2><span>Popular articles</span></h2><ul class="poplist"><li><a href="/wiki/Javier_Milei">Javier Milei</a> - Argentine libertarian economist, author, radio conductor and public speaker sympathetic to the Austrian School of economic thought. He became widely known for his regular ...</li><li><a href="/wiki/Jimmy_Carter">Jimmy Carter</a> - American politician, philanthropist, and former farmer who served as the 39th president of the United States from 1977 to 1981. A member of the Democratic Party, he previ...</li><li><a href="/wiki/UEFA_Euro_2024">UEFA Euro 2024</a> - The 2024 UEFA European Football Championship , commonly referred to as UEFA Euro 2024 or simply Euro 2024 , will be the 17th edition of the UEFA European Championship, the quadrennial internationa...</li><li><a href="/wiki/Argentina">Argentina</a> - country located mostly in the southern half of South America. Sharing the bulk of the Southern Cone with Chile to the west, the country is also b...</li><li><a href="/wiki/Sam_Altman">Sam Altman</a> - American entrepreneur, investor, programmer, and blogger. He is the former president of Y Combinator and now the CEO of OpenAI. Early life and education. ...</li><li><a href="/wiki/Rosalynn_Carter">Rosalynn Carter</a> - American who served as First Lady of the United States from 1977 to 1981 as the wife of President Jimmy Carter. For decades, she has been a leading advocate for numerou...</li><li><a href="/wiki/Next_Argentine_presidential_election">Next Argentine presidential election</a> - Next Argentine presidential election - presidential election in Argentina....</li></ul><h2><span>Popular movies</span></h2><ul class="poplist"><li><a href="/wiki/The_Hunger_Games_(film)">The Hunger Games (film)</a> - 2012 American dystopian action thriller science fiction-adventure film directed by Gary Ross and based on Suzanne Collins’s 2008 novel of the same name. It is the first insta...</li><li><a href="/wiki/untitled_Captain_Marvel_sequel">untitled Captain Marvel sequel</a> - part of Marvel Cinematic Universe....</li><li><a href="/wiki/Killers_of_the_Flower_Moon_(film_project)">Killers of the Flower Moon (film project)</a> - Killers of the Flower Moon - film project in United States of America. It was presented as drama, detective fiction, thriller. The film project starred Leonardo Dicaprio, Robert De Niro. Director of...</li><li><a href="/wiki/Five_Nights_at_Freddy's_(film)">Five Nights at Freddy's (film)</a> - Five Nights at Freddy's - film published in 2017 in United States of America. Scenarist of the film - Scott Cawthon....</li><h2><span>Popular video games</span></h2><ul class="poplist"><li><a href="/wiki/Minecraft">Minecraft</a> - sandbox video game developed by Mojang Studios. Created by Markus "Notch" Persson in the Java programming language and released as a public alpha for personal computers in 2...</li><li><a href="/wiki/Grand_Theft_Auto_V">Grand Theft Auto V</a> - 2013 action-adventure game developed by Rockstar North and published by Rockstar Games. It is the first main entry in the Grand Theft Auto series since 2008's Grand Theft ...</li><li><a href="/wiki/Roblox">Roblox</a> - online game platform and game creation system that allows users to program games and play games created by other users. Founded by David Baszucki and Erik Cassel in 2004 and released in...</li><li><a href="/wiki/Baldur's_Gate_III">Baldur's Gate III</a> - upcoming role-playing video game developed and published by Larian Studios for Microsoft Windows and the Stadia streaming service. It is the third main game in the Baldur's ...</li><li><a href="/wiki/Alan_Wake">Alan Wake</a> - action-adventure video game developed by Remedy Entertainment and published by Microsoft Studios, released for the Xbox 360 and Microsoft Windows. The story follows best-selling thri...</li><li><a href="/wiki/Fortnite">Fortnite</a> - online video game developed by Epic Games and released in 2017. It is available in three distinct game mode versions that otherwise share the same general gameplay and game engine: ...</li><li><a href="/wiki/Super_Mario_RPG">Super Mario RPG</a> - is a role-playing video game developed by Square and published by Nintendo for the Super Nintendo Entertainment System in 1996. It was directed by Yoshihiko Maekawa and Chihiro Fujioka and produced by...</li></ul><h2><span>Popular books</span></h2><ul class="poplist"><li><a href="/wiki/Book_of_Revelation">Book of Revelation</a> - The Book of Revelation is the final book of the New Testament, and consequently is also the final book of the Christian Bible. Its title is derived from the first word of the Koine Greek text: apok...</li><li><a href="/wiki/Book_of_Genesis">Book of Genesis</a> - account of the creation of the world, the early history of humanity, Israel's ancestors and the origins...</li><li><a href="/wiki/Gospel_of_Matthew">Gospel of Matthew</a> - The Gospel According to Matthew is the first book of the New Testament and one of the three synoptic gospels. It tells how Israel's Messiah, rejected and executed in Israel, pronounces judgement on ...</li><li><a href="/wiki/Michelin_Guide">Michelin Guide</a> - Michelin Guides are a series of guide books published by the French tyre company Michelin for more than a century. The term normally refers to the annually published Michelin Red Guide , the oldest...</li><li><a href="/wiki/Psalms">Psalms</a> - The Book of Psalms , commonly referred to simply as Psalms , the Psalter or "the Psalms", is the first book of the Ketuvim , the third section of the Hebrew Bible, and thus a book of th...</li><li><a href="/wiki/Ecclesiastes">Ecclesiastes</a> - Ecclesiastes is one of 24 books of the Tanakh , where it is classified as one of the Ketuvim . Originally written c. 450–200 BCE, it is also among the canonical Wisdom literature of the Old Tes...</li><li><a href="/wiki/The_48_Laws_of_Power">The 48 Laws of Power</a> - non-fiction book by American author Robert Greene. The book...</li></ul><h2><span>Popular television series</span></h2><ul class="poplist"><li><a href="/wiki/The_Crown_(TV_series)">The Crown (TV series)</a> - historical drama web television series about the reign of Queen Elizabeth II, created and principally written by Peter Morgan, and produced by Left Bank Pictures and Sony Pictures Tel...</li><li><a href="/wiki/Friends">Friends</a> - American sitcom television series, created by David Crane and Marta Kauffman, which aired on NBC from September 22, 1994, to May 6, 2004, lasting ten seasons. With an ensemble cast sta...</li><li><a href="/wiki/Young_Sheldon">Young Sheldon</a> - spin-off prequel to The Big Bang Theory and begins with the character Sheldon...</li><li><a href="/wiki/Modern_Family">Modern Family</a> - American television mockumentary family sitcom created by Christopher Lloyd and Steven Levitan for the American Broadcasting Company. It ran for eleven seasons, from September 23...</li><li><a href="/wiki/Loki_(TV_series)">Loki (TV series)</a> - upcoming American web television miniseries created for Disney+ by Michael Waldron, based on the Marvel Comics character of the same name. It is set in the Marvel Cinematic Universe, shar...</li><li><a href="/wiki/Game_of_Thrones">Game of Thrones</a> - American fantasy drama television series created by David Benioff and D. B. Weiss for HBO. It...</li><li><a href="/wiki/Shameless_(American_TV_series)">Shameless (American TV series)</a> - American comedy-drama television series developed by John Wells which debuted on Showtime on January 9, 2011. It...</li></ul> </aside> </div> <footer class="wrapper clearfix"> <a href="https://owiki.org">OWIKI.org</a>. Text is available under the Creative Commons Attribution-ShareAlike License. </footer> <script src="/js//jquery-1.9.0.min.js"></script> <script src="/js/main.js"></script> </body> </html>