Skip to content

Commit 20bfd32

Browse files
authored
Merge pull request #351 from DSpace/backport-349-to-dspace-9_x
[Port dspace-9_x] fix(item-requests) add missing access token information
2 parents dc6b048 + aff1fd9 commit 20bfd32

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

item-requests.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,16 @@ Provide detailed information about a specific request. The JSON response documen
2323
"token":"c19e820ea0b270f0ec98323864dcc8b8",
2424
"acceptRequest":false,
2525
"allfiles":false,
26+
"accessToken":null,
27+
"accessExpiry":null,
28+
"accessExpired":false,
2629
"type":"itemrequest",
2730
"bitstreamId":"dca2dadb-7028-40a9-ab39-1a47726df7ef",
2831
"itemId":"71d9fb0c-cc36-41c1-b1d3-63887b414fca",
2932
"requestEmail":"jsmith@example.com",
3033
"requestMessage":"Please send me a copy of this.",
3134
"requestName":"John Smith",
35+
"uniqueType": "tools.itemrequest",
3236
"_links":{
3337
"bitstream":{
3438
"href":"https://demo.dspace.org/server/api/tools/itemrequests/1/bitstream"
@@ -59,6 +63,9 @@ Item properties:
5963
* decisionDate: date that the request was granted or denied. READ-ONLY.
6064
* token: opaque string which uniquely identifies this request. READ-ONLY
6165

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

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

79+
## Find Single Request by Access Token
80+
**/api/tools/itemrequests/search/byAccessToken?accessToken=<:token>**
81+
82+
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").
83+
```json
84+
{
85+
"id": 7,
86+
"decisionDate": null,
87+
"expires": null,
88+
"requestDate": "2026-06-21T15:30:53.545094Z",
89+
"token": "sanitized",
90+
"acceptRequest": false,
91+
"allfiles": false,
92+
"accessToken": "ed38fdeb91d7ed870910b7aee9255bd6",
93+
"accessExpiry": null,
94+
"accessExpired": true,
95+
"requestMessage": "sanitized",
96+
"type": "itemrequest",
97+
"itemId": "5cf39972-48c3-453c-bb58-f635634e594f",
98+
"bitstreamId": "da6c314b-de45-4140-b1ec-b473a98c43a8",
99+
"requestEmail": "sanitized",
100+
"requestName": "sanitized",
101+
"uniqueType": "tools.itemrequest",
102+
"_links":{
103+
"bitstream":{
104+
"href":"https://demo.dspace.org/server/api/tools/itemrequests/7/bitstream"
105+
},
106+
"item":{
107+
"href":"https://demo.dspace.org/server/api/tools/itemrequests/7/item"
108+
},
109+
"self":{
110+
"href":"https://demo.dspace.org/server/api/tools/itemrequests/7"
111+
}
112+
}
113+
}
114+
```
115+
116+
Item properties:
117+
118+
Item properties, exposed links and response codes are the same as the single request endpoint described above.
119+
72120
## Creating a Request
73121
**POST /api/tools/itemrequests**
74122

0 commit comments

Comments
 (0)