All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
HTTP method | REST endpoint | Description |
---|---|---|
GET | /registries/schema | Return an array of all the schema in the registry |
GET | /registries/schema/{schema prefix} | Return the specified schema |
GET | /registries/schema/{schema prefix}/metadata-fields/{element} | Return the metadata field within a schema with an unqualified element name |
GET | /registries/schema/{schema prefix}/metadata-fields/{element}/{qualifier} | Return the metadata field within a schema with a qualified element name |
POST | /registries/schema/ | Add a schema to the schema registry. You must POST a schema object data type. |
POST | /registries/schema/{schema prefix}/metadata-fields | Add a metadata field to the specified schema. You must POST a metadatafield object data type. |
GET | /registries/metadata-fields/{field id} | Return the specified metadata field |
PUT | /registries/metadata-fields/{field id} | Update the specified metadata field |
DELETE | /registries/metadata-fields/{field id} | Delete the specified metadata field from the metadata field registry |
DELETE | /registries/schema/{schema id} | Delete the specified schema from the schema registry |
...
HTTP method | REST endpoint | Description |
---|---|---|
GET | /reports | Return a list of report tools built on the rest apiREST API |
GET | /reports/{nickname} | Return a redirect to a specific report |
GET | /filters | Return a list of use case filters available for quality control reporting |
GET | /filtered-collections | Return collections and item counts based on pre-defined filters |
GET | /filtered-collections/{collection id} | Return items and item counts for a collection based on pre-defined filters |
GET | /filtered-items | Retrieve a set of items based on a metadata query and a set of filters |
...
Anchor | ||||
---|---|---|---|---|
|
Code Block |
---|
{
"id":456,
"name":"Reports Community",
"handle":"10766/10213",
"type":"community",
"link":"/rest/communities/456",
"expand":["parentCommunity","collections","subCommunities","logo","all"],
"logo":null,
"parentCommunity":null,
"copyrightText":"",
"introductoryText":"",
"shortDescription":"Collection contains materials pertaining to the Able Family",
"sidebarText":"",
"countItems":3,
"subcommunities":[],
"collections":[]
} |
...
Anchor | ||||
---|---|---|---|---|
|
Code Block |
---|
{ "id":730, "name":"Annual Reports Collection", "handle":"10766/10214", "type":"collection", "link":"/rest/collections/730", "expand":["parentCommunityList","parentCommunity","items","license","logo","all"], "logo":null, "parentCommunity":null, "parentCommunityList":[], "items":[], "license":null, "copyrightText":"", "introductoryText":"", "shortDescription":"", "sidebarText":"", "numberItems":3 } |
...
Anchor | ||||
---|---|---|---|---|
|
Code Block |
---|
{ "id":14301, "name":"2015 Annual Report", "handle":"123456789/13470", "type":"item", "link":"/rest/items/14301", "expand":["metadata","parentCollection","parentCollectionList","parentCommunityList","bitstreams","all"], "lastModified":"2015-01-12 15:44:12.978", "parentCollection":null, "parentCollectionList":null, "parentCommunityList":null, "bitstreams":null, "archived":"true", "withdrawn":"false" } |
...
Anchor | ||||
---|---|---|---|---|
|
Code Block |
---|
{ "id":47166, "name":"appearance and physiology 100 percent copied from wikipedia.pdf", "handle":null, "type":"bitstream", "link":"/rest/bitstreams/47166", "expand":["parent","policies","all"], "bundleName":"ORIGINAL", "description":"", "format":"Adobe PDF", "mimeType":"application/pdf", "sizeBytes":129112, "parentObject":null, "retrieveLink":"/bitstreams/47166/retrieve", "checkSum":{"value":"62778292a3a6dccbe2662a2bfca3b86e","checkSumAlgorithm":"MD5"}, "sequenceId":1, "policies":null } |
...
Anchor | ||||
---|---|---|---|---|
|
Code Block |
---|
{ "id":317127, "action":"READ", "epersonId":-1, "groupId":0, "resourceId":47166, "resourceType":"bitstream", "rpDescription":null, "rpName":null, "rpType":"TYPE_INHERITED", "startDate":null, "endDate":null } |
Anchor | ||||
---|---|---|---|---|
|
Code Block |
---|
{ "key":"dc.description.abstract", "value":"This is the description abstract", "language": null } |
...
Anchor | ||||
---|---|---|---|---|
|
Code Block |
---|
{ "namespace" : "example.org/myschema", "prefix" : "myschema" } |
...
Code Block |
---|
{ "description" : "myschema test field", "element" : "test", "name" : "myschema.test", "qualifier": null } |
Code Block |
---|
{ "email":"test@dspace.org", "password":"pass" } |
Code Block |
---|
{
"okay":true,
"authenticated":true,
"email":"test@dspace.org",
"fullname":"DSpace Test User",
"token":"6d45daaa-7b02-4ae7-86de-a960838fae5c"
} |
...