Introduction

  • Its standard for REST APIs.
  • Its adapted by Microsoft and OASIS

OData Uri’s

Odata URI structure

  • [Service Root]/[Resource Name]/[Query Options]
  • Query Options can be filter, select etc

GET service document

Key Value
Method GET
Headers  
Url http://localhost:5810/odata/
Body  

GET metadata document

Key Value
Method GET
Headers  
Url http://localhost:5810/odata/$metadata
Body  

GET People

Key Value
Method GET
Headers Accept: application/json
Url http://localhost:5810/odata/People
Body  

GET People by ID

Key Value
Method GET
Headers Accept: application/json
Url http://localhost:5810/odata/People(1)
Body  

GET People full metadata

Key Value
Method GET
Headers Accept: application/json;odata.metadata=full
Url http://localhost:5810/odata/People
Body  

GET People minimal metadata

Key Value
Method GET
Headers Accept: application/json;odata.metadata=minimal
Url http://localhost:5810/odata/People
Body  

GET People no metadata

Key Value
Method GET
Headers Accept: application/json;odata.metadata=none
Url http://localhost:5810/odata/People
Body  

GET Attribute

Key Value
Method GET
Headers Accept: application/json
Url http://localhost:5810/odata/People(5)/Email
Body  

GET raw property value

Key Value
Method GET
Headers Accept: application/json
Url http://localhost:5810/odata/People(1)/Email/$value
Body  

GET collection property

Key Value
Method GET
Headers Accept: application/json
Url http://localhost:5810/odata/People(5)/Friends
Body  

POST Person

Key Value
Method POST
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People
Body { "@odata.type":"AirVinyl.Model.Person", "FirstName":"John", "LastName":"Smith", "Email": "john.smith@someprovider.com", "Gender":"Male", "DateOfBirth": "1980-01-30"}

POST Person and VinylRecords

Key Value
Method POST
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People
Body { "@odata.type":"AirVinyl.Model.Person", "FirstName":"Emma", "LastName":"Smith", "Email": "emma.smith@someprovider.com", "Gender":"Female", "DateOfBirth": "1989-05-16", "VinylRecords": [ { "Title":"Grace", "Artist":"Jeff Buckley", "CatalogNumber":"ABC/875" } ]}

Put Person

Key Value
Method PUT
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People(3)
Body { "FirstName": "Nick", "LastName": "Missorten", "DateOfBirth": "1983-05-18T00:00:00+02:00", "Gender": "Male", "NumberOfRecordsOnWishList": 23, "AmountOfCashToSpend": 2500}

Patch Person

Key Value
Method PATCH
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People(3)
Body { "FirstName": "Nick", "Email": "nick@someprovider.com"}

Delete Person

Key Value
Method DELETE
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People(3)
Body  

POST association

Key Value
Method POST
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People(7)/Friends/$ref
Body {"@odata.":"http://localhost:5810/odata/People(1))"}

PUT association

Key Value
Method PUT
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People(7)/Friends(1)/$ref
Body {"@odata.id": "http://localhost:5810/odata/People(3)"}

DELETE association

Key Value
Method DELETE
Headers Accept: application/json;Content-Type: application/json
Url http://localhost:5810/odata/People(7)/Friends/$ref?$id=http://localhost:5810/odata/People(3)
Body  

OData Query Options

  • EnableQuery attribute on the action filter enables the query options

  • Query options are

    • Parsed
    • Validated
    • Applied

select query option

  • Example
https://localhost/Jekyll::Drops::SiteDrop/api/v2/SDA/Objects?$filter=Class eq 'FDWDocumentVersion'&$select=Name,Description,OBID&$top=2

{
  "@odata.context": "https://localhost/SRLRMServer/api/v2/SDA/$metadata#Objects(Name,Description,OBID)",
  "value": [
    {
      "Name": "Test-001",
      "OBID": "6FIB006A",
      "Description": null
    },
    {
      "Name": "Testing-003",
      "OBID": "6FJS002A",
      "Description": null
    }
  ]
}

expand query option

Below Example:

  • Expand multiple rels (SPFFileComposition_21,SPFRevisionVersions_21, SPFDocumentRevisions_21).
  • Selects the Name, Class fields for each rel expanded.
  • If the expansion is at same level then the rel are separated by comma ($expand=SPFFileComposition_21($select=Name,Class),SPFRevisionVersions_21)
  • If there are multiple query options at inner level they are separated by semicolon ($select=Name,Class;$expand=SPFDocumentRevisions_21)
  • If there are multiple query options at top level they are separated by ampersand.
https://localhost/Jekyll::Drops::SiteDrop/api/v2/SDA/Objects?$filter=Class eq 'FDWDocumentVersion'&$select=Name,Description,OBID&$expand=SPFFileComposition_21($select=Name,Class),SPFRevisionVersions_21($select=Name,Class;$expand=SPFDocumentRevisions_21($select=Name,Class))&$top=2

{
  "@odata.context": "https://localhost/SRLRMServer/api/v2/SDA/$metadata#Objects(Name,Description,OBID,SPFFileComposition_21,SPFRevisionVersions_21,SPFFileComposition_21(Name,Class),SPFRevisionVersions_21(Name,Class,SPFDocumentRevisions_21,SPFDocumentRevisions_21(Name,Class)))",
  "value": [
    {
      "Name": "Test-001",
      "OBID": "6FIB006A",
      "Description": null,
      "SPFFileComposition_21": [],
      "SPFRevisionVersions_21": {
        "Name": "Test-001",
        "Class": "FDWDocumentRevision",
        "SPFDocumentRevisions_21": {
          "Name": "Test-001",
          "Class": "FDWDocumentMaster"
        }
      }
    },
    {
      "Name": "Testing-003",
      "OBID": "6FJS002A",
      "Description": null,
      "SPFFileComposition_21": [
        {
          "Name": "SRLRM Tags Report.xlsx",
          "Class": "SPFDesignFile"
        }
      ],
      "SPFRevisionVersions_21": {
        "Name": "Testing-003",
        "Class": "FDWDocumentRevision",
        "SPFDocumentRevisions_21": {
          "Name": "Testing-003",
          "Class": "FDWDocumentMaster"
        }
      }
    }
  ]
}