...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents |
|---|
Introduction
OpenSpecimen supports bulk/batch importing of many entities such as Collection Protocols, Specimen, Visits, Users, etc. Bulk Importing is used in high throughput biobanks or when the user needs to add/update multiple entities to/from OpenSpecimen. (Follow this page for an overview on the BulkImport module)
...
Download the input CSV template file
| Attribute | Value |
|---|---|
| URL | http://<host>:<port>/openspecimen/rest/ng/import-jobs/input-file-template?schema=<schemaName> |
| Method | GET |
| Request Type | application/json |
| Note |
|---|
Replace <schemaName> with the schema name for the entity you wish to bulk import. (Find here the schema name to entity mapping) |
Register your input file
| Attribute | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| URL | http://<host>:<port>/openspecimen/rest/ng/import-jobs/input-file | |||||||||
| Method | POST | |||||||||
| Request Type | form-data | |||||||||
| Response |
|
...
Deploy the input file and run the import-job
| Attribute | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| URL | http://<host>:<port>/openspecimen/rest/ng/import-jobs | |||||||||
| Method | POST | |||||||||
| Request Type | application/json | |||||||||
| Request |
|
...
Check status of the import-job
| Attribute | Value |
|---|---|
| URL | http://<host>:<port>/openspecimen/rest/ng/import-jobs/{job-id} |
| Method | GET |
| Request Type | application/json |
Example of Bulk Importing CP(s) using API
Follow this wiki-page to see an example of bulk importing CP(s) using bulk import API.
Error Cases
| Code | Applies to | Status Message |
|---|---|---|
| 200 | All requests | Bulk Import request was successfully processed. |
| 401 | All requests | Authorisation failed, user doesn’t have the authority. |
| 500 | All requests | Internal server error, encountered server error while performing operations. |