Versions Compared

Old Version 48

changes.mady.by.user ChrisC

Saved on

compared with

New Version 49

changes.mady.by.user ChrisC

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
A lightweight API for indexing metadata and links to existing derivatives into Avalon.  

...

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):

...

Retrieves a paginated list of all collectionscollections (parameters :page and :per_page specify page number and number per page for pagination)

GET /admin/collections/:id.json

...

Retrieves a paginated list of all items in collection :pid:pid (parameters :page and :per_page specify page number and number per page for pagination)

POST /admin/collections.json

...

      name: collection name, 
      description (optional): collection description, 
      unit: collection unit from controlled vocabulary, 
      managers: array of Avalon user ids or emails


Code Block
languagebash
titleGET /admin/collections.json
curl -H "Avalon-Api-Key:abcdef123456" "https://mallorn.dlib.indiana.edu/admin/collections.json?per_page=2&page=3"


Code Block
languagejs
titleExample Response
collapsetrue
[
  {
    "id": "1r66j1149",
    "name": "100 sec test",
    "unit": "Indiana University Libraries",
    "description": null,
    "object_count": {
      "total": 0,
      "published": 0,
      "unpublished": 0
    },
    "roles": {
      "managers": [
        "archivist1@example.com",
        "saidulla@iu.edu",
        "manager-cjc@example.com"
      ],
      "editors": [],
      "depositors": [
        "cjcolvar"
      ]
    }
  },
  {
    "id": "d791sg31t",
    "name": "2882 mallorn",
    "unit": "Indiana University Libraries",
    "description": null,
    "object_count": {
      "total": 5,
      "published": 0,
      "unpublished": 5
    },
    "roles": {
      "managers": [
        "saidulla@iu.edu"
      ],
      "editors": [
        "editor@example.com"
      ],
      "depositors": null
    }
  }
]


Code Block
languagebash
titleGET /admin/collections/:id.json
curl -H "Avalon-Api-Key:abcdef123456" https://mallorn.dlib.indiana.edu/admin/collections/d791sg31t.json


Code Block
languagejs
titleExample Response
collapsetrue
{
  "id": "d791sg31t",
  "name": "2882 mallorn",
  "unit": "Indiana University Libraries",
  "description": "",
  "object_count": {
    "total": 5,
    "published": 0,
    "unpublished": 5
  },
  "roles": {
    "managers": [
      "saidulla@iu.edu"
    ],
    "editors": [
      "editor@example.com"
    ],
    "depositors": []
  }
}


Code Block
languagebash
titleGET /admin/collections/:id/items.json
curl -H "Avalon-Api-Key:abcdef123456" "https://mallorn.dlib.indiana.edu/admin/collections/d791sg31t/items.json?per_page=2&page=2"


Code Block
languagejs
titleExample Response
collapsetrue
{
  "mk61rh07c": "{\"id\":\"mk61rh07c\",\"title\":\"elec1 2882 bug\",\"collection\":\"2882 mallorn\",\"unit\":\"Indiana University Libraries\",\"main_contributors\":[],\"publication_date\":null,\"published_by\":null,\"published\":false,\"summary\":null,\"visibility\":\"private\",\"read_groups\":[],\"files\":[{\"workflow_name\":\"avalon\",\"percent_complete\":null,\"status_code\":null,\"structure\":null,\"label\":\"\",\"thumbnail_offset\":2000,\"poster_offset\":2000,\"physical_description\":null,\"file_location\":\"/tmp/electricbeat-1.mp4\",\"file_size\":\"337659\",\"duration\":\"5334\",\"date_digitized\":\"2018-03-29T17:59:15Z\",\"file_checksum\":\"94000912e0c10c6c668f13dfb0a70072\",\"file_format\":\"Moving image\",\"other_identifier\":[],\"captions\":\"WEBVTT\\r\\n\\r\\n1\\r\\n00:00:00.200 --\\u003e 00:00:02.000\\r\\nTitle frame 1-2 sec\\r\\n\\r\\n2\\r\\n00:00:04.000 --\\u003e 00:00:05.000\\r\\n4 seconds\",\"captions_type\":\"text/vtt\",\"comment\":[],\"display_aspect_ratio\":\"1.3333333333333333\",\"original_frame_size\":\"320x240\",\"width\":320,\"height\":240,\"files\":[{\"label\":\"quality-high\",\"id\":\"track-8\",\"url\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:c9eb28f9-4ef3-4040-9478-1633bfa58b74/e3037981-dd6f-4663-b8b0-adb1c2dc54e2/electricbeat_1\",\"hls_url\":\"https://mallorn.dlib.indiana.edu:8980/avalon/c9eb28f9-4ef3-4040-9478-1633bfa58b74/e3037981-dd6f-4663-b8b0-adb1c2dc54e2/electricbeat_1.mp4.m3u8\",\"duration\":\"5334\",\"mime_type\":\"video/mp4\",\"audio_bitrate\":null,\"audio_codec\":null,\"video_bitrate\":\"2000000.0\",\"video_codec\":\"AVC\",\"width\":\"960\",\"height\":\"720\",\"location\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:c9eb28f9-4ef3-4040-9478-1633bfa58b74/e3037981-dd6f-4663-b8b0-adb1c2dc54e2/electricbeat_1\",\"track_id\":\"track-8\",\"hls_track_id\":\"track-11\",\"managed\":false,\"derivativeFile\":\"file:///var/avalon/rtmp_streams/c9eb28f9-4ef3-4040-9478-1633bfa58b74/e3037981-dd6f-4663-b8b0-adb1c2dc54e2/electricbeat_1.mp4\"},{\"label\":\"quality-medium\",\"id\":\"track-7\",\"url\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:c9eb28f9-4ef3-4040-9478-1633bfa58b74/826b8471-6125-4c88-b332-1026fa27b6aa/electricbeat_1\",\"hls_url\":\"https://mallorn.dlib.indiana.edu:8980/avalon/c9eb28f9-4ef3-4040-9478-1633bfa58b74/826b8471-6125-4c88-b332-1026fa27b6aa/electricbeat_1.mp4/index.m3u8\",\"duration\":\"5334\",\"mime_type\":\"video/mp4\",\"audio_bitrate\":null,\"audio_codec\":null,\"video_bitrate\":\"1064690.0\",\"video_codec\":\"AVC\",\"width\":\"640\",\"height\":\"480\",\"location\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:c9eb28f9-4ef3-4040-9478-1633bfa58b74/826b8471-6125-4c88-b332-1026fa27b6aa/electricbeat_1\",\"track_id\":\"track-7\",\"hls_track_id\":\"track-10\",\"managed\":false,\"derivativeFile\":\"file:///var/avalon/rtmp_streams/c9eb28f9-4ef3-4040-9478-1633bfa58b74/826b8471-6125-4c88-b332-1026fa27b6aa/electricbeat_1.mp4\"},{\"label\":\"quality-low\",\"id\":\"track-9\",\"url\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:c9eb28f9-4ef3-4040-9478-1633bfa58b74/10cd97b9-6d32-4196-9e9a-83250308b170/electricbeat_1\",\"hls_url\":\"https://mallorn.dlib.indiana.edu:8980/avalon/c9eb28f9-4ef3-4040-9478-1633bfa58b74/10cd97b9-6d32-4196-9e9a-83250308b170/electricbeat_1.mp4/index.m3u8\",\"duration\":\"5334\",\"mime_type\":\"video/mp4\",\"audio_bitrate\":null,\"audio_codec\":null,\"video_bitrate\":\"530724.0\",\"video_codec\":\"AVC\",\"width\":\"480\",\"height\":\"360\",\"location\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:c9eb28f9-4ef3-4040-9478-1633bfa58b74/10cd97b9-6d32-4196-9e9a-83250308b170/electricbeat_1\",\"track_id\":\"track-9\",\"hls_track_id\":\"track-12\",\"managed\":false,\"derivativeFile\":\"file:///var/avalon/rtmp_streams/c9eb28f9-4ef3-4040-9478-1633bfa58b74/10cd97b9-6d32-4196-9e9a-83250308b170/electricbeat_1.mp4\"}]}],\"fields\":{\"duration\":\"5334\",\"avalon_resource_type\":[\"moving image\"],\"avalon_publisher\":null,\"avalon_uploader\":\"saidulla@iu.edu\",\"identifier\":[],\"title\":\"elec1 2882 bug\",\"alternative_title\":[],\"translated_title\":[],\"uniform_title\":[],\"statement_of_responsibility\":null,\"creator\":[],\"date_created\":null,\"date_issued\":\"1111\",\"copyright_date\":null,\"abstract\":null,\"format\":[\"video/mp4\"],\"resource_type\":[],\"contributor\":[],\"publisher\":[],\"genre\":[],\"subject\":[],\"geographic_subject\":[],\"temporal_subject\":[],\"topical_subject\":[],\"terms_of_use\":null,\"table_of_contents\":[],\"physical_description\":[],\"record_identifier\":[\"http://127.0.0.1:8984/fedora4/rest/mk/61/rh/07/mk61rh07c\"],\"comment\":[],\"bibliographic_id\":null,\"bibliographic_id_label\":null,\"note\":null,\"note_type\":null,\"language\":null,\"related_item_url\":null,\"related_item_label\":null,\"other_identifier\":null,\"other_identifier_type\":null,\"rights_statement\":null}}",
  "sx61dm430": "{\"id\":\"sx61dm430\",\"title\":\"Luna r642\",\"collection\":\"2882 mallorn\",\"unit\":\"Indiana University Libraries\",\"main_contributors\":[],\"publication_date\":null,\"published_by\":null,\"published\":false,\"summary\":null,\"visibility\":\"private\",\"read_groups\":[],\"files\":[{\"workflow_name\":\"fullaudio\",\"percent_complete\":null,\"status_code\":null,\"structure\":null,\"label\":\"\",\"thumbnail_offset\":0,\"poster_offset\":0,\"physical_description\":null,\"file_location\":\"/tmp/Caruso-LunaDestate.mp3\",\"file_size\":\"2165531\",\"duration\":\"135209\",\"date_digitized\":\"2018-04-18T15:09:20Z\",\"file_checksum\":\"df20cc5ee6ec04ed63b0d8497e41fbd0\",\"file_format\":\"Sound\",\"other_identifier\":[],\"captions\":null,\"captions_type\":null,\"comment\":[],\"display_aspect_ratio\":null,\"original_frame_size\":null,\"width\":null,\"height\":null,\"files\":[{\"label\":\"quality-medium\",\"id\":\"track-7\",\"url\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:d7ffad5f-9c41-4106-94af-99abf055d5d5/9ff00ea7-2652-4087-a630-dc48638d861f/Caruso_LunaDestate\",\"hls_url\":\"https://mallorn.dlib.indiana.edu:8980/avalon/d7ffad5f-9c41-4106-94af-99abf055d5d5/9ff00ea7-2652-4087-a630-dc48638d861f/Caruso_LunaDestate.mp4.m3u8\",\"duration\":\"135207\",\"mime_type\":\"audio/mp4\",\"audio_bitrate\":\"124204.0\",\"audio_codec\":\"AAC\",\"video_bitrate\":null,\"video_codec\":null,\"width\":null,\"height\":null,\"location\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:d7ffad5f-9c41-4106-94af-99abf055d5d5/9ff00ea7-2652-4087-a630-dc48638d861f/Caruso_LunaDestate\",\"track_id\":\"track-7\",\"hls_track_id\":\"track-9\",\"managed\":false,\"derivativeFile\":\"file:///var/avalon/rtmp_streams/d7ffad5f-9c41-4106-94af-99abf055d5d5/9ff00ea7-2652-4087-a630-dc48638d861f/Caruso_LunaDestate.mp4\"},{\"label\":\"quality-high\",\"id\":\"track-6\",\"url\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:d7ffad5f-9c41-4106-94af-99abf055d5d5/cd18d1ca-870d-48fa-a395-c576efbf4bab/Caruso_LunaDestate\",\"hls_url\":\"https://mallorn.dlib.indiana.edu:8980/avalon/d7ffad5f-9c41-4106-94af-99abf055d5d5/cd18d1ca-870d-48fa-a395-c576efbf4bab/Caruso_LunaDestate.mp4/index.m3u8\",\"duration\":\"135207\",\"mime_type\":\"audio/mp4\",\"audio_bitrate\":\"147344.0\",\"audio_codec\":\"AAC\",\"video_bitrate\":null,\"video_codec\":null,\"width\":null,\"height\":null,\"location\":\"rtmp://mallorn.dlib.indiana.edu:1935/avalon/mp4:d7ffad5f-9c41-4106-94af-99abf055d5d5/cd18d1ca-870d-48fa-a395-c576efbf4bab/Caruso_LunaDestate\",\"track_id\":\"track-6\",\"hls_track_id\":\"track-8\",\"managed\":false,\"derivativeFile\":\"file:///var/avalon/rtmp_streams/d7ffad5f-9c41-4106-94af-99abf055d5d5/cd18d1ca-870d-48fa-a395-c576efbf4bab/Caruso_LunaDestate.mp4\"}]}],\"fields\":{\"duration\":\"135209\",\"avalon_resource_type\":[\"sound recording\"],\"avalon_publisher\":null,\"avalon_uploader\":\"saidulla@iu.edu\",\"identifier\":[],\"title\":\"Luna r642\",\"alternative_title\":[],\"translated_title\":[],\"uniform_title\":[],\"statement_of_responsibility\":null,\"creator\":[],\"date_created\":null,\"date_issued\":\"1212\",\"copyright_date\":null,\"abstract\":null,\"format\":[\"audio/mpeg\"],\"resource_type\":[],\"contributor\":[],\"publisher\":[],\"genre\":[],\"subject\":[],\"geographic_subject\":[],\"temporal_subject\":[],\"topical_subject\":[],\"terms_of_use\":null,\"table_of_contents\":[],\"physical_description\":[],\"record_identifier\":[\"http://127.0.0.1:8984/fedora4/rest/sx/61/dm/43/sx61dm430\"],\"comment\":[],\"bibliographic_id\":null,\"bibliographic_id_label\":null,\"note\":null,\"note_type\":null,\"language\":null,\"related_item_url\":null,\"related_item_label\":null,\"other_identifier\":null,\"other_identifier_type\":null,\"rights_statement\":null}}"
}


Code Block
languagebash
titlePOST /admin/collections.json
curl -H "Avalon-Api-Key:abcdef123456" -X POST -d @data.json -H "Content-type:application/json" -H "Accept:application/json" https://mallorn.dlib.indiana.edu/admin/collections.json


Code Block
languagejs
titleExample Request Data (data.json)
collapsetrue
{
   "admin_collection" : {
      "unit" : "Indiana University Libraries",
      "managers" : [
         "archivist1@example.com"
      ],
      "description" : "This great new collection has all new content from the IU Libraries.",
      "name" : "New Collection"
   }
}


Code Block
languagejs
titleExample Response
collapsetrue
{"id":"ht24wj605"}


Code Block
languagebash
titlePUT /admin/collections/:id.json
curl -H "Avalon-Api-Key:abcdef123456" -X PUT -d @data.json -H "Content-type:application/json" -H "Accept:application/json" https://mallorn.dlib.indiana.edu/admin/collections/ht24wj605.json


Code Block
languagejs
titleExample Request Data (data.json)
collapsetrue
{
   "admin_collection" : {
      "unit" : "Indiana University Libraries",
      "managers" : [
         "archivist1@example.com"
      ],
      "description" : "This great collection has all mostly new content from the IU Libraries.",
      "name" : "Not Quite So New Collection"
   }
}


Code Block
languagejs
titleExample Response
collapsetrue
{"id":"ht24wj605"}


Anchor
units
units
Units

...

In Avalon, units are part of a controlled vocabulary. To add a new unit, a call to the vocabulary is required.

...