REST API
This page describes types of Aidbox REST API operations in general
Aidbox provides two REST APIs - FHIR and Aidbox. The main difference is a format of resources. Base URL for FHIR API is /fhir and for Aidbox /
Interaction type | | Format |
Instance Level Interactions | | |
Read the current state of the resource | both | |
Read the state of a specific version of the resource | both | |
Update an existing resource by its id (or create it if it is new) | both | |
Update an existing resource by posting a set of changes to it | both | |
Delete a resource | both | |
Retrieve the change history for a particular resource | both | |
Type Level Interactions | | |
Create a new resource | both | |
Search the resource type based on some filter criteria | both | |
Retrieve the change history for a particular resource type | both | |
Dump all resources of specific type | Aidbox | |
Load resources of specific type | both | |
Whole System Interactions | | |
Get a capability statement for the system | FHIR | |
Update, create or delete a set of resources in a single interaction | both | |
Batch create or update interaction | Aidbox | |
Bulk Import async operation | both | |
Bulk load ndjson file with resources | both | |
Bulk export result of SQL Query | Aidbox | |
history | Not supported for performance reason | |
search | Not supported for performance reason | |
Last modified 2yr ago