We use cookies for security, analytics and session persistence reasons. Please refer to our Cookie Policy for more information.
On this page a more detailed explanation of the data present in OLIDA and the different ways to access this data is detailed. This documentation introduces the different concepts and entities that are part of OLIDA and describes the features of this web interface in detail. An overview of the capabilities of the REST API is provided in addition to the descriptions of the data structure. Finally, tutorials illustrate the core use-cases for OLIDA and the F.A.Q. section answers some of the most frequently asked questions.
NOTE: Depending on variant type, certain columns may or may not be present in the table. We discuss all columns of different tables and will indicate when a column is only present in a specific variant table.
In addition to the web interface for this website, a REST API is also provided for machine readable access of the data. The contents of the API can be explored through the API page. The API allows for retrieval of data with HTTP GET requests to the available endpoints with a token authentification. An OPTIONS HTTP request will return metadata that describes the API endpoints. Documentation on how to use this API is available as a Swagger-UI or as a Redoc interface. The schema of the API follows the OpenAPI standard and is formatted according to the JSONAPI specification. The specification for the API is available in both JSON and YAML formats.
A token can be obtained through POST request with the command :
curl -X POST "https://olida.ibsquare.be/api-token/" -d "{ \"username\": \"user\", \"password\": \"yourpassword\"}"
with user and yourpassword replaced with your credentials. The API should respond in a similar way as follows:
{"token": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"}
The token can then be used in the header for all the requests sent to the API as in the example below:
curl -X GET https://olida.ibsquare.be/api/combinations/ -H 'Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b'
Authentication to the API can also be done through the Swagger and Redoc interfaces by login to the Django session.
This API was created using the Django REST framework extension.
Click the headers below to expand tutorials on those subjects
All curated data from OLIDA can be accessed from the Browse page, which is shown in Figure 1.1.
For every table, the top left contains buttons to download data and toggle columns on or off in the displayed table. The "Download" button allows for the data to be downloaded by selecting one of the supported formats from the dropdown menu. Currently, the TSV and Excel formats are supported. Figure 1.2 below shows a closeup of the format selection dropdown for downloading data.
To download the data in JSON format, one can use the REST API. To toggle columns of the table, simply click the column visibility dropdown and select or unselect a column name. By default all columns of a table are shown, columns that do not fit on the screen are displayed to the right and can be viewed by scrolling horizontally. Names of active columns will have a blue background, while the name of hidden columns will have a whit background. Figure 1.3 below shows the Oligogenic variant Combinations table with some columns disabled.
To search for a particular entry in the tables that are displayed in the Browse page, the main search bar on top of the page can be used. Users can select which tables that should be searched by enabling/disabling the elements in the dropdown to the left of the search input. By default all tables are searched. To disable search for a particular table one has to click on the corresponding element in the dropdown. Clicking on a disabled item will re-enable search for the associated table. Additionally, one can Ctrl/Cmd+click an element to search the selected table only and disable search for all others. Only visible columns will be searched. Figure 1.4 shows an example of search with certain tables being excluded.
The Advanced search feature is still under development. A tutorial on how to use it will be added here when it is ready.
Besides browsing through the existing data, we also allow users to submit their research data in order to expand the contents of the database. New submissions will only be accepted after careful manual inspection to ensure that all provided data is of high quality. The submission wizard is available from the SUBMIT page. Note that we require submitters to either be logged in with a user account or to minimally provide basic information that will allow us to contact the user.
The slides below show the different steps of the submission wizard and detail what data should be provided for each step. Below each slide a description of the step is provided and the data or actions which are required or optional in the step are discussed.
The API can be used directly through the GUI as a Swagger-UI or as a Redoc interface.
However, you can also access to the API programmatically as long as you possess a username and the related password to OLIDA. You can find a Python script example here.
If you still have questions after reading this documentation, you can contact us at olida@ibsquare.be. We will try to get in touch with you as quickly as possible and if relevant will add the question and answer to this F.A.Q..