Accesarea resurselor serviciilor de date (WCF Data Services)

• 30.03.2017
• 5 minute de citit

• • m

  • v

  • A

  • n

  • n

In acest articol

WCF Data Services accepta Open Data Protocol (OData) pentru a va expune datele ca feed cu resurse care pot fi adresate de URI-uri. Aceste resurse sunt reprezentate in conformitate cu conventiile entitate-relatie ale modelului de date entitate. In acest model, entitatile reprezinta unitati operationale de date care sunt tipuri de date intr-un domeniu de aplicatie, cum ar fi clienti, comenzi, articole si produse. Datele entitatii sunt accesate si modificate utilizand semantica transferului de stare reprezentativa (REST), in special verbele HTTP standard ale GET, PUT, POST si DELETE.

Resurse de adresare

In OData, abordati orice date expuse de modelul de date utilizand un URI. De exemplu, urmatorul URI returneaza un flux care este setul de entitati Clienti, care contine intrari pentru toate instantele tipului de entitate Client:

https://services.odata.org/Northwind/Northwind.svc/Customers

Entitatile au proprietati speciale numite chei de entitate. O cheie de entitate este utilizata pentru a identifica in mod unic o singura entitate dintr-un set de entitati. Aceasta va permite sa adresati o instanta specifica unui tip de entitate din setul de entitati. De exemplu, urmatorul URI returneaza o intrare pentru o instanta specifica a tipului de entitate Client care are o valoare cheie ALFKI:

https://services.odata.org/Northwind/Northwind.svc/Customers(‘ALFKI ‘)

Proprietatile primitive si complexe ale unei instante de entitate pot fi, de asemenea, abordate individual. De exemplu, urmatorul URI returneaza un element XML care contine valoarea proprietatii ContactName pentru un anumit Client:

https://services.odata.org/Northwind/Northwind.svc/Customers(‘ALFKI’)/ContactName

Cand includeti punctul final al valorii $ in URI-ul anterior, numai valoarea proprietatii primitive este returnata in mesajul de raspuns. Urmatorul exemplu returneaza numai sirul „Maria Anders” fara elementul XML:

https://services.odata.org/Northwind/Northwind.svc/Customers(‘ALFKI’)/ContactName/$value

Relatiile dintre entitati sunt definite in modelul de date de catre asociatii. Aceste asociatii va permit sa va adresati entitatilor conexe utilizand proprietatile de navigare ale unei instante de entitate. O proprietate de navigatie poate returna fie o singura entitate legata, in cazul unei relatii multi-la-unu, fie un set de entitati conexe, in cazul unei relatii unu-la-multi. De exemplu, urmatorul URI returneaza un flux care este setul tuturor comenzilor care sunt legate de un anumit client:

https://services.odata.org/Northwind/Northwind.svc/Customers(‘ALFKI’)/Orders

Relatiile, care sunt de obicei bidirectionale, sunt reprezentate de o pereche de proprietati de navigatie. Ca inversul relatiei aratate in exemplul anterior, urmatorul URI returneaza o referinta la entitatea client de care apartine o anumita entitate de comanda:

https://services.odata.org/Northwind/Northwind.svc/Orders(10643)/Customer

OData va permite, de asemenea, sa abordati resursele pe baza rezultatelor expresiilor de interogare. Acest lucru face posibila filtrarea seturilor de resurse pe baza unei expresii evaluate. De exemplu, urmatorul URI filtreaza resursele pentru a returna numai comenzile pentru clientul specificat care au fost expediate incepand cu 22 septembrie 1997:

https://services.odata.org/Northwind/Northwind.svc/Customers(‘ALFKI’)/Orders?$filter=ShippedDate gt datetime’1997-09-22T00: 00: 00 ‘

Pentru mai multe informatii, consultati OData: Conventii URI.

Optiuni interogare sistem

OData defineste un set de optiuni de interogare a sistemului pe care le puteti utiliza pentru a efectua operatiuni de interogare traditionale impotriva resurselor, cum ar fi filtrarea, sortarea si paginarea. De exemplu, urmatorul URI returneaza setul tuturor entitatilor de comanda, impreuna cu entitatile de ordine_detalii aferente, ale caror coduri postale nu se termina in 100:

https://services.odata.org/Northwind/Northwind.svc/Orders?$filter=not endswith (ShipPostalCode, ‘100’) & $ expand = Order_Details & $ orderby = ShipCity

Intrarile in fluxul returnat sunt, de asemenea, ordonate in functie de valoarea proprietatii ShipCity a comenzilor.

WCF Data Services accepta urmatoarele optiuni de interogare a sistemului OData:

Interogare Optiune Descriere $ orderby Defineste o ordine de sortare implicita pentru entitatile din fluxul returnat. Urmatoarea interogare comanda hrana clientilor returnati in functie de judet si oras:

https://services.odata.org/Northwind/Northwind.svc/Customers?$orderby=Country,City>

$ top Specifica numarul de entitati de inclus in feedul returnat. Urmatorul exemplu omite primii 10 clienti si apoi returneaza urmatorii 10:

https://services.odata.org/Northwind/Northwind.svc/Customers?$skip=10&$top=10

$ skip Specifica numarul de entitati de ignorat inainte de a incepe sa returneze entitati in flux. Urmatorul exemplu omite primii 10 clienti si apoi returneaza urmatorii 10:

https://services.odata.org/Northwind/Northwind.svc/Customers?$skip=10&$top=10

$ filter Defineste o expresie care filtreaza entitatile returnate in flux pe baza unor criterii specifice. Aceasta optiune de interogare accepta un set de operatori de comparatie logica, operatori aritmetici si functii de interogare predefinite care sunt utilizate pentru a evalua expresia filtrului. Urmatorul exemplu returneaza toate comenzile ale caror coduri postale nu se termina in 100:

https://services.odata.org/Northwind/Northwind.svc/Orders?$filter=not endswith (ShipPostalCode, ‘100’)

$ expand Specifica entitatile conexe care sunt returnate de interogare. Entitatile conexe sunt incluse fie ca feed, fie ca intrare in linie cu entitatea returnata de interogare. Urmatorul exemplu returneaza comanda pentru clientul „ALFKI” impreuna cu detaliile articolului pentru fiecare comanda:

https://services.odata.org/Northwind/Northwind.svc/Customers(‘ALFKI’)/Orders?$expand=Order_Details

$ select Specifica o proiectie care defineste proprietatile entitatii care sunt returnate in proiectie. In mod implicit, toate proprietatile unei entitati sunt returnate intr-un flux. Urmatoarea interogare returneaza doar trei proprietati ale entitatii Client:

https://services.odata.org/Northwind/Northwind.svc/Customers?$select=CustomerID,CompanyName,City

$ inlinecount Solicita includerea in flux a numarului de entitati returnate in flux.

Abordarea relatiilor

In addition to addressing entity sets and entity instances, OData also enables you to address the associations that represent relationships between entities. This functionality is required to be able to create or change a relationship between two entity instances, such as the shipper that is related to a given order in the Northwind sample database. OData supports a $link operator to specifically address the associations between entities. For example, the following URI is specified in an HTTP PUT request message to change the shipper for the specified order to a new shipper.

https://services.odata.org/Northwind/Northwind.svc/Orders(10643)/$links/Shipper

For more information, see section 3.2. Addressing Links between Entries at OData: URI Conventions.

Consuming the Returned Feed

The URI of an OData resource enables you to address entity data exposed by the service. When you enter a URI into the address field of a Web browser, a OData feed representation of the requested resource is returned. For more information, see the WCF Data Services Quickstart. Although a Web browser may be useful for testing that a data service resource returns the expected data, production data services that can also create, update, and delete data are generally accessed by application code or scripting languages in a Web page. For more information, see Using a Data Service in a Client Application.

See also

• Open Data Protocol Web site