OData

The OData endpoints adhere to the standards defined by the OData organization in the document here:

Authenticating to the OData API is the same as for the other endpoints, as described here

Endpoints

The endpoints described below adhere to the most recent OData version (4). Version 3 is supported on the /odatav3 endpoint, but not described here.

Root

GET /odata

Response

application/json

Returns a JSON object with an URL to the metadata document, and available EntitySets. Currently only database views are returned. Scifeon entities EntitySets are planned.

Metadata

GET /odata/$metadata

Response

application/xml

Returns an XML document describing the properties of the EntityTypes used in the EntitySets.

EntitySet endpoint

GET /odata/{view}

Request

Path parameters

• view A EntitySet, i.e. a name of a database view.

Query parameters

{{include:includes/_query.md}}

Response

application/json

Returns a object of the following format:

{
    "@odata.context": "/odata/$metadata#{view}",
    "value": [{
        // object with properties as described by the metadata document
    }]
}

Examples