Page History
...
| HTTP method | REST endpoint | Description |
|---|---|---|
| GET | /communities | Return an array of all the communities in the repository. The results are paginated. Example: |
| GET | /communities/top-communities | Return an array of all top-level communities. The results are paginated. Example: |
| GET | /communities/{community id} | Return the specified community. Example: https://demo.dspace.org/rest/communities/e97b847b-2fd5-4751-8d91-fcf0d8895b81 |
| GET | /communities/{community id}/collections | Return an array of collections of the specified community. The results are paginated. |
| GET | /communities/{community id}/communities | Return an array of sub-communities of the specified community. The results are paginated. |
| POST | /communities | Create a new community at top level. You must post POST a community object data type. |
| POST | /communities/{community id}/collections | Create a new collections in the specified community. You must post POST a collection object data type. |
| POST | /communities/{community id}/communities | Create a new sub-community in the specified community. You must post POST a community object data type. |
| PUT | /communities/{community id} | Update the specified community. You must put PUT a community object data type. |
| DELETE | /communities/{community id} | Delete the specified community. |
| DELETE | /communities/{community id}/collections/{collection id} | Delete the specified collection in the specified community. |
| DELETE | /communities/{community id}/communities/{sub-community id} | Delete the specified sub-community in the specified community. |
...
| HTTP method | REST endpoint | Description |
|---|---|---|
| GET | /collections | Return an array of all the collections in the repository. The results are paginated. |
| GET | /collections/{collection id} | Return the specified collection. |
| GET | /collections/{collection id}/items | Return an array all items of the specified collection. The results are paginated. |
| POST | /collections/{collection id}/items | Create an item in the specified collection. You must post POST an item object data type. |
| POST | /collections/find-collection | Find collection by passed name. Returns the first exact match or nothing. You must post POST a single string, not a JSON object. |
| PUT | /collections/{collection id} | Update the specified collection. You must put PUT a collection object data type. |
| DELETE | /collections/{collection id} | Delete the specified collection. |
| DELETE | /collections/{collection id}/items/{item id} | Delete the specified item in the specified collection. |
...
| HTTP method | REST endpoint | Description |
|---|---|---|
| GET | /items | Return an array of all the items in the repository. The results are paginated. Example: |
| GET | /items/{item id} | Return the specified item. |
| GET | /items/{item id}/metadata | Return metadata of the specified item. |
| GET | /items/{item id}/bitstreams | Return an array of all the bitstreams of the specified item. The results are paginated. |
| POST | /items/find-by-metadata-field | Find items by metadata entry. You must post POST a metadataentry object data type. |
| POST | /items/{item id}/metadata | Add metadata to the specified item. You must post POST an array of metadataentry object data type. |
| POST/GET | /items/{item id}/bitstreams?name={file name} | Add bitstream to the specified item. You must post POST the file data and include the name parameter with the value as {file name} in the URL posted to.
description: A description of the bitstream. groupId: Id of group to set item resource policy to. year: Year to set embargo date to month: Month to set embargo date to day: Day of month to set embargo date to Example: /items/{item id}/bitstreams?name=The%20Children%27s%20Crusade%3A%20A%20Duty-Dance%20with%20Death.pdf&description=All%20this%20happened%2C%20more%20or%20less.&groupID=1969&year=2045&month=2&day=13 |
| PUT | /items/{item id}/metadata | Update metadata in the specified item. You must put PUT a metadataentry object data type. Each metadata entry that will replace all prior matching metadata entries, i.e. if you submit n 'dc.subject' entries all pre-existing 'dc.subject' entries in the item will be deleted and replaced with the n entries |
| DELETE | /items/{item id} | Delete the specified item. |
| DELETE | /items/{item id}/metadata | Clear the metadata of the specified item. |
| DELETE | /items/{item id}/bitstreams/{bitstream id} | Delete the specified bitstream of the specified bitstream. |
...
| HTTP method | REST endpoint | Description |
|---|---|---|
| GET | /bitstreams | Return an array of all the bitstreams in the repository. The results are paginated. Example: |
| GET | /bitstreams/{bitstream id} | Return the specified bitstream. |
| GET | /bitstreams/{bitstream id}/policy | Return bitstream policies. |
| GET | /bitstreams/{bitstream id}/retrieve | Return data of bitstream. |
| POST | /bitstreams/{bitstream id}/policy | Add policy to item. You must post POST a resourcepolicy object data type. |
| PUT | /bitstreams/{bitstream id}/data | Update the data/file of the specified bitstream. You must put PUT the data. |
| PUT | /bitstreams/{bitstream id} | Update metadata of the specified bitstream. You must put PUT a Bitstreambitstream, does not alter the file/data. |
| DELETE | /bitstreams/{bitstream id} | Delete the specified bitstream. |
| DELETE | /bitstreams/{bitstream id}/policy/{policy id} | Delete the specified resource policy of the specified bitstream. |
...
| 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. |
| 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 |
...
Overview
Content Tools