OData

https://docs.oasis-open.org/odata/odata/v4.01
Admin
The Open Data Protocol (OData) enables the creation and consumption of REST-based data services,...
Tokens:146,824
Snippets:1,042
Trust Score:9.5
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Example 20: Canonical URL for previous example

Source: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html

Shows the canonical URL for the same entity, omitting the key property name.

```http
http://host/service/Products(1)
```

--------------------------------

### Multipart batch response example (Example 104)

Source: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html

Example 104: multipart batch response referencing batch request example 101, assuming all requests except the final query succeed. Shows a 200 Ok multipart/mixed response with a boundary, a change set (cs_12u7hdkin252452345eknd_383673037) containing a 201 Created and a 204 No Content, and a final 404 Not Found error part. The response structure matches the request one-to-one except for change set failures and error termination.

```http
HTTP/1.1 200 Ok  
OData-Version: 4.0  
Content-Length: ####  
Content-Type: multipart/mixed; boundary=b_243234_25424_ef_892u748  
  

--b_243234_25424_ef_892u748  
Content-Type: application/http  
  
HTTP/1.1 200 Ok  
Content-Type: application/json  
Content-Length: ###  
  
<JSON representation of the Customer entity with key ALFKI>
--b_243234_25424_ef_892u748  
Content-Type: multipart/mixed; boundary=cs_12u7hdkin252452345eknd_383673037  
  

--cs_12u7hdkin252452345eknd_383673037  
Content-Type: application/http  
Content-ID: 1  
  

HTTP/1.1 201 Created  
Content-Type: application/json  
Location: http://host/service.svc/Customer('POIUY')  
Content-Length: ###  
  

<JSON representation of the new Customer entity>  
  

--cs_12u7hdkin252452345eknd_383673037  
Content-Type: application/http  
Content-ID: 2  
  
HTTP/1.1 204 No Content  
Host: host  
  
  

--cs_12u7hdkin252452345eknd_383673037--
--b_243234_25424_ef_892u748  
Content-Type: application/http  
  
HTTP/1.1 404 Not Found  
Content-Type: application/xml  
Content-Length: ###  
  
<Error message>  
--b_243234_25424_ef_892u748—
```

--------------------------------

### Example 47: $all with $search

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Example 47: all entities in a service that somehow match red. The $all resource is located at the service root and identifies the collection of all entities in a service.

```http
http://host/service/$all?$search=red
```

--------------------------------

### Example 49: POST /$query with filter in body

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Example 49: passing a filter condition in the request body. The request uses POST to /$query with content-type text/plain and the query options in the body.

```http
POST http://host/service/People/$query
Content-Type: text/plain
$filter=[FirstName,LastName]%20in%20[["John","Doe"],["Jane","Smith"]]
```

--------------------------------

### Example 48: $all with type restriction and $filter

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Example 48: all Customer entities in a service whose name contains red. The $all resource is appended with the qualified entity type name Model.Customer to restrict the collection.

```http
http://host/service/$all/Model.Customer?$filter=contains(Name,'red')
```

--------------------------------

### Example 41: Combining /$filter path segment and $filter system query option

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Combines the /$filter path segment with the $filter system query option to select red products costing less than 10.

```HTTP
GET Products/$filter(@foo)?@foo=Price lt 10&$filter=Color eq 'red'
```

--------------------------------

### Example 101: Multipart batch request with change set

Source: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html

Example 101: a multipart batch request containing a query request, a change set with an insert (Content-ID=1) and an update (Content-ID=2), and a second query request. Request bodies are replaced with English descriptions inside <> brackets and OData-Version headers are omitted for brevity. The two empty lines after the Host header of the GET request are necessary: the first is part of the GET request header; the second is the empty body of the GET request, followed by a CRLF according to RFC2046.

```http
POST /service/$batch HTTP/1.1   
Host: host   
OData-Version: 4.0  
Content-Type: multipart/mixed; boundary=batch_36522ad7-fc75-4b56-8c71-56071383e77b
Content-Length: ###
--batch_36522ad7-fc75-4b56-8c71-56071383e77b  
Content-Type: application/http   
  
GET /service/Customers('ALFKI')   
Host: host  
  
  
--batch_36522ad7-fc75-4b56-8c71-56071383e77b  
Content-Type: multipart/mixed; boundary=changeset_77162fcd-b8da-41ac-a9f8-9357efbbd  
  

--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd   
Content-Type: application/http   
Content-ID: 1  
  
POST /service/Customers HTTP/1.1   
Host: host  
Content-Type: application/json   
Content-Length: ###   
  
<JSON representation of a new Customer>
--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd   
Content-Type: application/http   
Content-ID: 2  
  
PATCH /service/Customers('ALFKI') HTTP/1.1   
Host: host   
Content-Type: application/json   
If-Match: xxxxx 
Prefer: return=minimal  
Content-Length: ###   
  
<JSON representation of changes to Customer ALFKI>
--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd--  
--batch_36522ad7-fc75-4b56-8c71-56071383e77b   
Content-Type: application/http   
  
GET /service/Products HTTP/1.1   
Host: host   
  
  
--batch_36522ad7-fc75-4b56-8c71-56071383e77b--
```

--------------------------------

### Example 42: Combining two /$filter path segments

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Uses two /$filter path segments with parameter aliases to select red products costing less than 10.

```HTTP
GET Products/$filter(@p)/$filter(@c)?@p=Price lt 10&@c=Color eq 'red'
```

--------------------------------

### Example 38: Cast complex property to derived type and get property

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Casts the complex property Address to its derived type DetailedAddress, then retrieves the Location property of the derived type.

```http
http://host/service/Customers(1)/Address/Model.DetailedAddress/Location 
```

--------------------------------

### Customer payload advertising bound function

Source: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html

Shows a Customer entity representation that includes the SampleEntities.MostRecentOrder function bound to the entity, with a title and target URL. This is an example response to a GET request to http://host/service/Customers('ALFKI').

```JSON
{  
"@context": ...,  
"CustomerID": "ALFKI",   
"CompanyName": "Alfreds Futterkiste",   
"#SampleEntities.MostRecentOrder": {  
"title": "Most Recent Order",  
"target": "Customers('ALFKI')/SampleEntities.MostRecentOrder()"  
},  
...  
}
```

--------------------------------

### Example 101: Batch request with query, change set, and second query

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part1-protocol/odata-v4.01-os-part1-protocol.html

Complete multipart batch request example showing the order: a query request, a change set with two operations (insert and update), and a second query request. The change set uses Content-ID headers and the batch boundary is batch_36522ad7-fc75-4b56-8c71-56071383e77b. Request bodies are omitted for brevity.

```HTTP
POST /service/$batch HTTP/1.1   
Host: host   
OData-Version: 4.0  
Content-Type: multipart/mixed; boundary=batch_36522ad7-fc75-4b56-8c71-56071383e77b
Content-Length: ###
--batch_36522ad7-fc75-4b56-8c71-56071383e77b  
Content-Type: application/http   
  
GET /service/Customers('ALFKI')   
Host: host  
  
  
--batch_36522ad7-fc75-4b56-8c71-56071383e77b  
Content-Type: multipart/mixed; boundary=changeset_77162fcd-b8da-41ac-a9f8-9357efbbd  
  
--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd   
Content-Type: application/http   
Content-ID: 1  
  
POST /service/Customers HTTP/1.1   
Host: host  
Content-Type: application/json   
Content-Length: ###   
  
<JSON representation of a new Customer>
--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd   
Content-Type: application/http   
Content-ID: 2  
  
PATCH /service/Customers('ALFKI') HTTP/1.1   
Host: host   
Content-Type: application/json   
If-Match: xxxxx 
Prefer: return=minimal  
Content-Length: ###   
  
<JSON representation of changes to Customer ALFKI>
--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd--  
--batch_36522ad7-fc75-4b56-8c71-56071383e77b   
Content-Type: application/http   
  
GET /service/Products HTTP/1.1   
Host: host   
  
  
--batch_36522ad7-fc75-4b56-8c71-56071383e77b--
```

--------------------------------

### Primitive Literals in $filter Expressions (Example 102)

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Example 102 from section 5.1.1.14.1 shows primitive literals used in $filter expressions. It includes null, boolean, binary, integer, double, single, decimal, string, date, datetimeoffset, duration, timeofday, guid, int64, enumeration, and geography literals. In OData 4.01, duration and enumeration literals may be used with or without the type prefix, but clients targeting both 4.0 and 4.01 should always include the prefix.

```OData
NullValue eq null
TrueValue eq true
FalseValue eq false
Custom.Base64UrlDecode(binary'T0RhdGE') eq 'OData'
IntegerValue lt -128
DoubleValue ge 0.31415926535897931e1
SingleValue eq INF
DecimalValue eq 34.95
StringValue eq 'Say Hello,then go'
DateValue eq 2012-12-03
DateTimeOffsetValue eq 2012-12-03T07:16:23Z
DurationValue eq duration'P12DT23H59M59.999999999999S'
DurationValue eq 'P12DT23H59M59.999999999999S'
TimeOfDayValue eq 07:59:59.999
GuidValue eq 01234567-89ab-cdef-0123-456789abcdef
Int64Value eq 0
ColorEnumValue eq Sales.Pattern'Yellow',
ColorEnumValue eq 'Yellow',
geo.distance(Location,geography'SRID=0;Point(142.1 64.1)')
```

--------------------------------

### Cross join response example

Source: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html

Example response for the cross join query, showing the structure with navigation links for each joined entity set.

```json
{
  "@odata.context":"http://host/service/$metadata#Collection(Edm.ComplexType)",
  "value":[
    {
      "Products@odata.navigationLink":"Products(0)",
      "Sales@odata.navigationLink":"Sales(42)",
    },
    {
      "Products@odata.navigationLink":"Products(0)",
      "Sales@odata.navigationLink":"Sales(57)",
    },
    ...
    {
      "Products@odata.navigationLink":"Products(99)",
      "Sales@odata.navigationLink":"Sales(21)",
    }
  ]
}
```

--------------------------------

### Example 26: Multi-part key predicate, parentheses-style and key-as-segment

Source: https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html

Shows two equivalent URL forms for addressing an entity with a multi-part key: the parentheses-style and the key-as-segment convention.

```http
https://host/service/OrderItems(OrderID=1,ItemNo=2) 
https://host/service/OrderItems/1/2
```

--------------------------------

### Example 24: alternate key and canonical key URLs

Source: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html

Shows three equivalent URLs for the same employee: one using an alternate key (SSN), one using the canonical key with property name, and one using the canonical short form.

```http
http://host/service/Employees(SSN='123-45-6789')
```

```http
http://host/service/Employees(ID='A1245')
```

```http
http://host/service/Employees('A1245')
```

--------------------------------

### Skip results with $skip

Source: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html

Excludes the first five products and returns items starting at position 6. The service returns items starting at position n+1.

```HTTP
GET http://host/service/Products?$skip=5
```
Tokens:
Raw