API for retrieving technical and structural information about data items.
Not a complete implementation of but conform to the following OASIS standards:
Example: /object/a5-1/Object(hdl:11341/00-0000-0000-0000-1BD6-5)?pretty
{ "@odata.context": "a5:/object/a5-1/Object", "@odata.id": "hdl:11341/00-0000-0000-0000-1BD6-5", "@odata.readLink": "/object/a5-1/Object(hdl:11341/00-0000-0000-0000-1BD6-5)", "@odata.mediaReadLink": "/media/a5-1/hdl:11341/00-0000-0000-0000-1BD6-5", "@a5.selector": { "repository": "a5-1", "identifier": "hdl:11341/00-0000-0000-0000-1BD6-5", "$expand": null, "pretty": true }, "@a5.expandable": [ "parentOf" ], "id": "hdl:11341/00-0000-0000-0000-1BD6-5", "label": "Family Problems Mercy and Alex", "objectType": "Collection", "contentType": "text/cmdi+xml", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/elasticsearch/MercyAlex.cmdi", "fileUriVersion": "/pair/tree/v2/content/elasticsearch/MercyAlex.cmdi", "fileExists": true, "fileUpdated": "2020-08-18T13:50:43Z", "fileCreated": "2020-08-18T13:50:43Z", "fileSize": 24979, "parentOf": [ "hdl:11341/00-0000-0000-0000-1C6E-6", "hdl:11341/00-0000-0000-0000-1C6D-F", "hdl:11341/00-0000-0000-0000-1C6C-1", "hdl:11341/00-0000-0000-0000-1C6B-3", "hdl:11341/00-0000-0000-0000-1C70-0", "hdl:11341/00-0000-0000-0000-1C6F-2", "hdl:11341/00-0000-0000-0000-1BFE-0", "hdl:11341/00-0000-0000-0000-1BFF-A", "hdl:11341/00-0000-0000-0000-1BFB-2", "hdl:11341/00-0000-0000-0000-1BFD-E", "hdl:11341/00-0000-0000-0000-1BFC-3", "hdl:11341/00-0000-0000-0000-1BD9-D", "hdl:11341/00-0000-0000-0000-1BD8-6", "hdl:11341/00-0000-0000-0000-1BD7-3" ], "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "fecae0ef9711e88415b7fe1cc883b12e", "sha1": "6cc327da2c693c71302b064dc839471a5ffea5d1", "sha256": "85a2ac3c3b291ac0ace2deaa61b92fa5e14491d35d8724d988c3107c8e341b7e", "sha512": "027c9db3a21669a693f262a05132490c1c553d6a99a908c3d769110af3c56503a03c6190ce79c2a09d2575354b45068f3a500a3e945f247394d10a826f7831ac" } }
Example: /object/a5-1/Objects?pretty
{ "@odata.context": "a5:/object/a5-1/Objects", "@odata.nextLink": "?$skip=10", "@a5.selector": { "repository": "a5-1", "$count": false, "$filter": null, "$orderby": null, "$select": null, "$skip": 0, "$top": 10, "pretty": true }, "value": [ { "@odata.id": "a5:repository_test_a_image", "@odata.readLink": "/object/a5-1/Object(a5:repository_test_a_image)", "@odata.mediaReadLink": "/media/a5-1/a5:repository_test_a_image", "Thumbnail@odata.mediaReadLink": "/media/a5-1/a5:repository_test_a_image/full/full/{size}/0/none/default.jpg", "id": "a5:repository_test_a_image", "label": "a_image.jpg", "objectType": "Resource", "contentType": "image/jpeg", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/test_repository/Media/a_image.jpg", "fileUriVersion": "/pair/tree/v2/content/test_repository/Media/a_image.jpg", "fileExists": true, "fileUpdated": "2020-08-18T13:50:44Z", "fileCreated": "2020-08-18T13:50:44Z", "fileSize": 27661, "width": 275, "height": 297, "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "c8e7e1fc344be6982710f54d47191ef6", "sha1": "628a43d996686e654934e27c99e51afe432fc164", "sha256": "8c712905b799905357b8202d0cb7a244cefeeccf7aa5eb79896645ac50158ffa", "sha512": "a4531309b530e72d0e733777d1f9993d59a067f68735e2c067ec865eac4c09a5f5e619ce2329b9f64c2f9e65a9719e33223794ae4e74018bea438fd77cdbb837" } }, { "@odata.id": "a5:repository_test_a_text", "@odata.readLink": "/object/a5-1/Object(a5:repository_test_a_text)", "@odata.mediaReadLink": "/media/a5-1/a5:repository_test_a_text", "Thumbnail@odata.mediaReadLink": "/media/a5-1/a5:repository_test_a_text/full/full/{size}/0/none/default.jpg", "id": "a5:repository_test_a_text", "label": "a_text.txt", "objectType": "Resource", "contentType": "text/plain", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/test_repository/Media/not_a_image.jpg", "fileUriVersion": "/pair/tree/v2/content/test_repository/Media/a_text.txt", "fileExists": true, "fileUpdated": "2020-08-18T13:50:44Z", "fileCreated": "2020-08-18T13:50:44Z", "fileSize": 4, "width": 0, "height": 0, "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "098f6bcd4621d373cade4e832627b4f6", "sha1": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "sha512": "ee26b0dd4af7e749aa1a8ee3c10ae9923f618980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5fa9ad8e6f57f50028a8ff" } }, { "@odata.id": "a5:repository_test_not_a_pdf", "@odata.readLink": "/object/a5-1/Object(a5:repository_test_not_a_pdf)", "@odata.mediaReadLink": "/media/a5-1/a5:repository_test_not_a_pdf", "Thumbnail@odata.mediaReadLink": "/media/a5-1/a5:repository_test_not_a_pdf/full/full/{size}/0/none/default.jpg", "id": "a5:repository_test_not_a_pdf", "label": "not_a_pdf.pdf", "objectType": "Resource", "contentType": "application/pdf", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/test_repository/Media/not_a_image.jpg", "fileUriVersion": "/pair/tree/v2/content/test_repository/Media/not_a_pdf.pdf", "fileExists": true, "fileUpdated": "2020-08-18T13:50:44Z", "fileCreated": "2020-08-18T13:50:44Z", "fileSize": 4, "width": 0, "height": 0, "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "098f6bcd4621d373cade4e832627b4f6", "sha1": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "sha512": "ee26b0dd4af7e749aa1a8ee3c10ae9923f618980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5fa9ad8e6f57f50028a8ff" } }, { "@odata.id": "a5:repository_test_corrupt_audio", "@odata.readLink": "/object/a5-1/Object(a5:repository_test_corrupt_audio)", "@odata.mediaReadLink": "/media/a5-1/a5:repository_test_corrupt_audio", "Waveform@odata.mediaReadLink": "/media/a5-1/a5:repository_test_corrupt_audio/{section}/full/{size}/0/waveform/default.png", "Spectrum@odata.mediaReadLink": "/media/a5-1/a5:repository_test_corrupt_audio/{section}/full/{size}/0/spectrum/default.png", "id": "a5:repository_test_corrupt_audio", "label": "corrupt_audio.wav", "objectType": "Resource", "contentType": "audio/x-wav", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/test_repository/Media/corrupt_audio.wav", "fileUriVersion": "/pair/tree/v2/content/test_repository/Media/corrupt_audio.wav", "fileExists": true, "fileUpdated": "2020-08-18T13:50:44Z", "fileCreated": "2020-08-18T13:50:44Z", "fileSize": 213003, "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "4dd92586625945e74fea54d9a7b0e2e8", "sha1": "4feb5653d48ec94992bb71c983674a1f843883ba", "sha256": "e97d2a083d7e6927f4e7428cad052e041cf354fb1fecc8f880f74836798a0281", "sha512": "d104c5269eb0a4cf931a132159a94aeb5b971a3dd8cd1e402c310afdc38cd8b1072114f28ab2c44268362090830e683e598a8fc2e12c6c2d045bf3cc5ff85387" } }, { "@odata.id": "hdl:11341/00-0000-0000-0000-0C64-2", "@odata.readLink": "/object/a5-1/Object(hdl:11341/00-0000-0000-0000-0C64-2)", "@odata.mediaReadLink": "/media/a5-1/hdl:11341/00-0000-0000-0000-0C64-2", "id": "hdl:11341/00-0000-0000-0000-0C64-2", "label": "Fieldnotes", "objectType": "Collection", "contentType": "text/cmdi+xml", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/elasticsearch/Fieldnotes.cmdi", "fileUriVersion": "/pair/tree/v2/content/elasticsearch/Fieldnotes.cmdi", "fileExists": true, "fileUpdated": "2020-08-18T13:50:43Z", "fileCreated": "2020-08-18T13:50:43Z", "fileSize": 2593, "parentOf": [ "hdl:11341/00-0000-0000-0000-0C61-0", "hdl:11341/00-0000-0000-0000-0C5F-A", "hdl:11341/00-0000-0000-0000-0C5D-3" ], "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "fd6f130e718753ae0596a28e4fa84d39", "sha1": "db5ab83b42839ccf24a38a6c3d33a67405d042d1", "sha256": "6f4f762f7054f879f3d976e76eef8d00f95a57f0f8f7ac7a90a114d11b37e1b5", "sha512": "9024bfda1d11924f13c6e7983b2d2c6a16eeb86c6630d2c4c1c6824321fe88a13489d4cf6875b091f7154f09d61fb3a0276de10281f12f0fe86e8c7012dd2cca" } }, { "@odata.id": "hdl:11341/00-0000-0000-0000-1AFC-4", "@odata.readLink": "/object/a5-1/Object(hdl:11341/00-0000-0000-0000-1AFC-4)", "@odata.mediaReadLink": "/media/a5-1/hdl:11341/00-0000-0000-0000-1AFC-4", "id": "hdl:11341/00-0000-0000-0000-1AFC-4", "label": "Vowels 2", "objectType": "Collection", "contentType": "text/cmdi+xml", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/elasticsearch/ZAG_EOI_20141023_4.cmdi", "fileUriVersion": "/pair/tree/v2/content/elasticsearch/ZAG_EOI_20141023_4.cmdi", "fileExists": true, "fileUpdated": "2020-08-18T13:50:43Z", "fileCreated": "2020-08-18T13:50:43Z", "fileSize": 13610, "parentOf": [ "hdl:11341/00-0000-0000-0000-1B5B-3", "hdl:11341/00-0000-0000-0000-1B5A-7" ], "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "50200c2d66f5a3413224b4c166604a0e", "sha1": "a072ae2d92428fd895f26276a94032c0271ff6a7", "sha256": "f4f662f6d69e23e6aa9e3e814052ed7826ac38340032b9d9a3443fd7a396019c", "sha512": "66dd44b7277f6f8c77a5545e57939905e8ec6c672a558185e608c41480c78b015826255ae2f8f7132975a1fb13da9f9acca77f5a19b9699c74a13d11a5b6e02c" } }, { "@odata.id": "hdl:11341/00-0000-0000-0000-1B22-A", "@odata.readLink": "/object/a5-1/Object(hdl:11341/00-0000-0000-0000-1B22-A)", "id": "hdl:11341/00-0000-0000-0000-1B22-A", "label": "ZAG_EOI_20141204_3.mp4", "objectType": "Resource", "contentType": "video/mp4", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUriVersion": "/pair/tree/v2/content/Media/ZAG_EOI_20141204_3.mp4", "fileExists": false, "accessRights": [ "foaf:Agent" ] }, { "@odata.id": "hdl:11341/00-0000-0000-0000-1B61-8", "@odata.readLink": "/object/a5-1/Object(hdl:11341/00-0000-0000-0000-1B61-8)", "id": "hdl:11341/00-0000-0000-0000-1B61-8", "label": "ZAG_EOI_20141111_3.wav", "objectType": "Resource", "contentType": "audio/x-wav", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUriVersion": "/pair/tree/v2/content/Media/ZAG_EOI_20141111_3.wav", "fileExists": false, "accessRights": [ "foaf:Agent" ] }, { "@odata.id": "hdl:11341/00-0000-0000-0000-1B50-E", "@odata.readLink": "/object/a5-1/Object(hdl:11341/00-0000-0000-0000-1B50-E)", "id": "hdl:11341/00-0000-0000-0000-1B50-E", "label": "ZAG_EOI_20150209_1.wav", "objectType": "Resource", "contentType": "audio/x-wav", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUriVersion": "/pair/tree/v2/content/Media/ZAG_EOI_20150209_1.wav", "fileExists": false, "accessRights": [ "foaf:Agent" ] }, { "@odata.id": "hdl:11341/00-0000-0000-0000-1A8B-B", "@odata.readLink": "/object/a5-1/Object(hdl:11341/00-0000-0000-0000-1A8B-B)", "@odata.mediaReadLink": "/media/a5-1/hdl:11341/00-0000-0000-0000-1A8B-B", "id": "hdl:11341/00-0000-0000-0000-1A8B-B", "label": "Wordlist for languages in Papua: 202-212", "objectType": "Collection", "contentType": "text/cmdi+xml", "containerId": "ocfl:/pair/tree", "containerVersion": "v2", "containerVersionPredecessors": [ "v1" ], "containerVersionSuccessors": [ ], "containerVersionIsLatest": true, "containerVersionCreated": "2020-07-01T08:19:42Z", "fileUri": "/pair/tree/v1/content/elasticsearch/BAL_FEFO13_LM_Sitzung8_14_11_2013_SS_1.cmdi", "fileUriVersion": "/pair/tree/v2/content/elasticsearch/BAL_FEFO13_LM_Sitzung8_14_11_2013_SS_1.cmdi", "fileExists": true, "fileUpdated": "2020-08-18T13:50:43Z", "fileCreated": "2020-08-18T13:50:43Z", "fileSize": 27082, "parentOf": [ "hdl:11341/00-0000-0000-0000-1A8C-9" ], "accessRights": [ "foaf:Agent" ], "checksum": { "md5": "f3cad10795a73159bb91641026d2d585", "sha1": "a49bf2d0e3892e6a9ab8b8087ae4885ba6462a37", "sha256": "f495bf086e04224aa2f7e754bf6b0e0892b9fa0d3cf9500103b9db5fb7fdbd37", "sha512": "8cb1722f1583eb7fac7a4fb6cd006bf1df22544d69c7df7aca0318b983e9598e81691350ba3a3f86e8d9041645bef3aee8fc4e42cd77c93baadf2f70d161c622" } } ] }
GET {scheme}://{server}/object/{repository}/Object({$identifier})
Returns a single object.
Example: /object/a5-1/Object(hdl:11341/00-0000-0000-0000-1BD6-5)?pretty
GET {scheme}://{server}/object/{repository}/Object({$identifier})?$expand=field1,field2
Expands related objects.
Example | Description |
---|---|
/object/a5-1/Object(hdl:11341/00-0000-0000-0000-1BD6-5)?pretty&$expand=parentOf | Replaces all ids found in field "parentOf" with the expanded object. |
GET {scheme}://{server}/object/{repository}/Objects
Returns a collection of objects.
Example: /object/a5-1/Objects?pretty
By default the first 10 objects are returned. A @odata.nextLink property appears if more objects are available.
GET {scheme}://{server}/object/{repository}/Objects?$filter={field1 (eq|ne|gt|ge|lt|le) 'term1' (and|or|not) field2 (eq|ne|gt|ge|lt|le) 'term2' ...}
Filters objects according to field values.
Example | Description |
---|---|
/object/a5-1/Objects?pretty&$filter=id eq hdl:11341/00-0000-0000-0000-1BD6-5 | Returns object with id "hdl:11341/00-0000-0000-0000-1BD6-5". No quotes are used here to enclose the term. |
/object/a5-1/Objects?pretty&$filter=contentType eq 'text/eaf%2Bxml' | Returns all objects with content type "text/eaf+xml". Note that the plus sign "+" has to be encoded as "%2B". |
/object/a5-1/Objects?pretty&$filter=parentOf eq 'hdl:11341/00-0000-0000-0000-1BD6-5' | Returns the parent of object "hdl:11341/00-0000-0000-0000-1BD6-5". The term is enclosed in single quotes here. |
/object/a5-1/Objects?pretty&$filter=fileCreated lt 2016-10-24T11:31:09.342655Z and contentType eq video/mp4 | Returns all objects with files created before "2016-10-24T11:31:09.342655Z" and content type "video/mp4". |
/object/a5-1/Objects?pretty&$filter=(contentType eq text/eaf%2Bxml or contentType eq audio/x-wav) and fileExists eq true | Returns all objects with content type equals "text/eaf+xml" or "audio/x-wav" that property "fileExists" equals to "true". |
GET {scheme}://{server}/object/{repository}/Objects?$orderby=field1 (asc|desc),field2 (asc|desc),..
Sorts objects according to selected field values.
Example | Description |
---|---|
/object/a5-1/Objects?pretty&$orderby=fileUpdated asc | Returns all objects of repository "a5-1" sorted by field "fileUpdated" in ascending order. |
/object/a5-1/Objects?pretty&$orderby=fileCreated desc | Returns all objects of repository "a5-1" sorted by field "fileCreated" in descending order. |
/object/a5-1/Objects?pretty&$orderby=fileUpdated asc,fileCreated desc | Returns all objects of repository "a5-1" primarily sorted by field "fileUpdated" in ascending order and secondarily sorted by field "fileCreated" in descending order. |
GET {scheme}://{server}/object/{repository}/Objects?$skip={integer}&$top={integer}
Allows navigation inside a object collection.
Example | Description |
---|---|
/object/a5-1/Objects?pretty&$skip=10&$top=10 | Returns objects 10 to 20. |
/object/a5-1/Objects?pretty&$skip=20&$top=1 | Returns the 20th object. |
GET {scheme}://{server}/object/{repository}/Objects?$count
If true includes number of hits of a object collection request. Default is true.
Example | Description |
---|---|
/object/a5-1/Objects?pretty&$count | A "@odata.count" parameter appears if "$count" is set. |
/object/a5-1/Objects?pretty&$count&$top=0 | A typical usage is to combine "$count" with the "$top" parameter set to "0". |
GET {scheme}://{server}/object/{repository}/Objects?$select={field1,field2,field3,..}
Defines which fields to include in the JSON result.
Example | Description |
---|---|
/object/a5-1/Objects?pretty&$select=fileCreated,fileExists | Returns all objects of repository a5-1 only showing fields fileCreated and fileExists. |
GET {scheme}://{server}/object/{repository}/Objects?pretty
Whether to return the JSON response pretty printed.
Example | Description |
---|---|
/object/a5-1/Objects | Prints any JSON response in compact form in format "application/json" for production use. |
/object/a5-1/Objects?pretty | Prints any JSON response in human readable form in format "text/plain" for debbuging only. |