ODataDB API Samples

This sample shows ODataDB API usage examples.

You can choose a platform:

We recommend these third-party resource to learn OData basics and standards:

https://www.odata.org/getting-started/basic-tutorial/

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

Service Document

GET https://odatadb.savetodb.com/v4/mssql-021/

Metadata

GET https://odatadb.savetodb.com/v4/mssql-021/$metadata

Endpoints

GET https://odatadb.savetodb.com/v4/mssql-021/
GET https://odatadb.savetodb.com/v4/mssql-021/en-us/
GET https://odatadb.savetodb.com/v4/mssql-021/default/
GET https://odatadb.savetodb.com/v4/mssql-021/default/en-us/

Requesting entity collections based on tables

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook

Requesting entity collections based on views with primary keys

GET https://odatadb.savetodb.com/v4/mssql-021/view_cashbook

Requesting entity collections based on views without primary keys

GET https://odatadb.savetodb.com/v4/mssql-021/xl_actions_online_help

Requesting individual entities by id

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook(1)
GET https://odatadb.savetodb.com/v4/mssql-021/cashbook(id=1)
GET https://odatadb.savetodb.com/v4/mssql-021/item_companies(item_id=1,company_id=1)

Invoking functions based on stored procedures or functions

GET https://odatadb.savetodb.com/v4/mssql-021/usp_cashbook()
GET https://odatadb.savetodb.com/v4/mssql-021/usp_cashbook(1,1,1)
GET https://odatadb.savetodb.com/v4/mssql-021/usp_cashbook(item_id=1,company_id=1)

Requesting properties

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook/debit
GET https://odatadb.savetodb.com/v4/mssql-021/cashbook(1)/debit
GET https://odatadb.savetodb.com/v4/mssql-021/cashbook(1)/company
GET https://odatadb.savetodb.com/v4/mssql-021/companies(1)/cashbooks

$select

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$select=date,debit

$orderby

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$orderby=debit desc,credit

$apply

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$apply=groupby((date))

$filter

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$filter=item_id eq 1
GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$filter=debit gt 100000
GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$filter=date eq 2023-01-10
GET https://odatadb.savetodb.com/v4/mssql-021/companies?$filter=tolower(name) eq %27customer c1%27
GET https://odatadb.savetodb.com/v4/mssql-021/companies?$expand=cashbooks($filter=debit eq 100000)

$search

GET https://odatadb.savetodb.com/v4/mssql-021/companies?$search=Customer
GET https://odatadb.savetodb.com/v4/mssql-021/companies?$search="Customer C"

$expand

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$expand=account,item,company
GET https://odatadb.savetodb.com/v4/mssql-021/companies?$expand=cashbooks
GET https://odatadb.savetodb.com/v4/mssql-021/companies(1)?$expand=cashbooks

$count

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$count=true

$ref

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook(1)/$ref

$value

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook(1)/debit/$value

$top and $skip

GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$top=10
GET https://odatadb.savetodb.com/v4/mssql-021/cashbook?$top=10&$skip=10

Extensions

GET https://odatadb.savetodb.com/v4/mssql-171/$excel_formats?app=savetodb
GET https://odatadb.savetodb.com/v4/mssql-171/usp_request/$excel_format?app=savetodb
GET https://odatadb.savetodb.com/v4/mssql-171/usp_request/$table_format
GET https://odatadb.savetodb.com/v4/mssql-171/usp_request/$definition
GET https://odatadb.savetodb.com/v4/mssql-023/$workbooks