Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions item-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,16 @@ Provide detailed information about a specific request. The JSON response documen
"token":"c19e820ea0b270f0ec98323864dcc8b8",
"acceptRequest":false,
"allfiles":false,
"accessToken":null,
"accessExpiry":null,
"accessExpired":false,
"type":"itemrequest",
"bitstreamId":"dca2dadb-7028-40a9-ab39-1a47726df7ef",
"itemId":"71d9fb0c-cc36-41c1-b1d3-63887b414fca",
"requestEmail":"jsmith@example.com",
"requestMessage":"Please send me a copy of this.",
"requestName":"John Smith",
"uniqueType": "tools.itemrequest",
"_links":{
"bitstream":{
"href":"https://demo.dspace.org/server/api/tools/itemrequests/1/bitstream"
Expand Down Expand Up @@ -59,6 +63,9 @@ Item properties:
* decisionDate: date that the request was granted or denied. READ-ONLY.
* token: opaque string which uniquely identifies this request. READ-ONLY

* accessToken: unique token providing access to a requested resource. READ-ONLY.
* accessExpiry: date on which the access to the requested resource expires
* accessExpired: true if access is expired (supercedes accessExpiry). READ-ONOLY.
Exposed links:

* item: the item requested
Expand All @@ -69,6 +76,47 @@ Return codes:
* 200 OK - if the operation succeeded
* 404 NOT FOUND - if the token is unknown (no such request exists)

## Find Single Request by Access Token
**/api/tools/itemrequests/search/byAccessToken?accessToken=<:token>**

Search for a single request item by access token (the token given to the user for authenticated access to a requested resource). Provides information sufficient for frontend processing / status information but no personal details about the requestor, or approval token (the fields will be present but the values replaced by the string "sanitized").
```json
{
"id": 7,
"decisionDate": null,
"expires": null,
"requestDate": "2026-06-21T15:30:53.545094Z",
"token": "sanitized",
"acceptRequest": false,
"allfiles": false,
"accessToken": "ed38fdeb91d7ed870910b7aee9255bd6",
"accessExpiry": null,
"accessExpired": true,
"requestMessage": "sanitized",
"type": "itemrequest",
"itemId": "5cf39972-48c3-453c-bb58-f635634e594f",
"bitstreamId": "da6c314b-de45-4140-b1ec-b473a98c43a8",
"requestEmail": "sanitized",
"requestName": "sanitized",
"uniqueType": "tools.itemrequest",
"_links":{
"bitstream":{
"href":"https://demo.dspace.org/server/api/tools/itemrequests/7/bitstream"
},
"item":{
"href":"https://demo.dspace.org/server/api/tools/itemrequests/7/item"
},
"self":{
"href":"https://demo.dspace.org/server/api/tools/itemrequests/7"
}
}
}
```

Item properties:

Item properties, exposed links and response codes are the same as the single request endpoint described above.

## Creating a Request
**POST /api/tools/itemrequests**

Expand Down
Loading