https://bd-api.ncsa.illinois.edu (Swagger API documentation)
Headers must include a valid token as follows:
{
"Authorization":token
}DAP (Conversions)
| GET | /dap/outputs | List all output formats that can be reached |
| GET | /dap/inputs | List all input formats that can be accepted |
| GET | /dap/inputs/{input_format} | List all output formats that can reach the specified input format. Limit the number of hops allowed by setting chain parameter, e.g.: ?chain=2 |
| GET | /dap/convert | List all output formats that can be reached |
| GET | /dap/convert/{output_format} | List all input formats that can reach the specified output format |
| GET | /dap/convert/{output_format}/{file_url} | Convert the specified file to the requested output format. Specify the specific application to use with the application parameter, e.g.: ?application=PEcAn |
| POST | /dap/convert/{output_format} | Convert the uploaded file to the requested output format |
| GET | /dap/path/{output_format}/{input_format} | Return the conversion path that would be used for this conversion |
| GET | /dap/software | List all available conversion software |
| GET | /dap/software/{software} | List all output formats available for this software |
| GET | /dap/software/{software}/{output_format} | List all input formats available for this software |
| GET | /dap/servers | List all currently available Software Servers |
DTS (Extractions)
| GET | /dts/api/extractions/supported_input_types | Lists the input file format supported by currently running extractors |
| POST | /dts/api/extractions/upload_url | Uploads a file for extraction using the file's URL |
| POST | /dts/api/extractions/upload_file | Uploads a file for extraction of metadata and returns file id. To disable auto-extraction pass in header: Content-Type: extractors/nogo |
| GET | /dts/api/extractions/{id}/status | Checks for the status of all extractors processing the file with id |
| GET | /dts/api/files/{id}/metadata.jsonld | Get metadata associated with the file (in JSON-LD) |
| GET | /dts/api/files/{id}/tags | Gets tags associated with the file |
| GET | /dts/api/files/{id}/versusmetadata | Get Versus metadata associated with the file |
| POST | /dts/api/files/{id}/extractions | Run a specific extractor on the file. Specify which extractor within the body of a JSON document, for example: { |
| GET | /dts/api/extractors | Lists the past and present registered extractors |
| GET | /dts/api/extractions/extractors_names | Lists the currently running extractors |
| GET | /dts/api/extractions/extractors_details | Lists the details of the currently running extractors |
| GET | /extractors | List all extractors that would be executed for the given file type specified in the parameters, e.g.: ?file_type=image/jpg |
| GET | /dts/api/extractions/server_ips | Lists servers IPs running the extractors |
DataWolf (Executors)
| POST | /dw/provenance | Display an editable workflow for a given transformation (specified in body): { |
Proposed modifications to the DAP and DTS API's are in discussion here.
4 Comments
Gregory Jansen
This page should include at least a link to the authorization side of the API. It mentions the token at the top, but most users will not know how to get that without a link or inline instructions. It's the first thing they have to do to use the API.
Kenton McHenry
FYI, this page will no longer be the main reference to the API once the Swagger documentation Luigi Marini is working on is done.
Gregory Jansen
Is this page still accurate? If not, it should probably be removed or hidden as it is public.
Luigi Marini
Good point Gregory Jansen. Kenton McHenry can I delete the old info about the endpoints and add some text about the swagger api?