A simple API for interacting with Avalon objects.
...
Version
...
Date
...
Description
...
0.1
...
13 October 2015
...
Initial Draft
...
0.2
...
16 December 2015
...
API as implemented
...
0.3
(Avalon 7.0)
...
03 January 2020
...
Authorization scheme enhanced
status_code, percent_complete, percent_succeeded, and percent_failed fields removed from Media Object parameters
...
0.4
(Avalon 7.1)
...
26 March 2020
...
.
| Table of Contents | ||
|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
...
If true, fields must include value for :bibliographic_id and may include value from controlled vocabulary for :bibliographic_id_label)
Bib import failure will result in a JSON response: {errors: ['Bib import failed', e.message]}, status: 422
replace_masterfiles (optional boolean):
...
| Code | Description |
|---|---|
| 200 | Okay. For GET, the relevant JSON will be contained in response body. For PUTS and POST response body will contain id of created/updated item. |
| 201 | <Not used> Created |
| 202 | <Not used> Accepted, Queued |
| 400 | Bad request |
| 401 | Auth Failure. No token present in request header 'Avalon-Api-Key' |
| 403 | Forbidden. Invalid token in request header 'Avalon-Api-Key' |
| 404 | Resource Not Found. If object is not found for requested id. |
| 405 | <Not used> Method Prohibited |
| 409 | <Not used> Conflict/Other Error. Conflict ex: id in use |
| 422 | Processing failed. Response body will contain JSON hash with :errors key pointing to a list of error message strings. |
Version History
Version | Date | Description |
|---|---|---|
0.1 | 13 October 2015 | Initial Draft |
0.2 | 16 December 2015 | API as implemented |
0.3 | 03 January 2020 | Authorization scheme enhanced |
0.4 | 26 March 2020 | MediaObject - add masterfile ids, derivative ids are actual ids instead of track ids now, structure can be inlined with query param |