Skip to content

Fix and update item request API documentation #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
saschaszott wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix and update item request API documentation #344

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f042fa5
Update item request API documentation
saschaszott Jun 14, 2026
db0a94f
Update item request creation documentation
saschaszott Jun 14, 2026
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
11 changes: 9 additions & 2 deletions item-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ Return codes:
## Creating a Request
**POST /api/tools/itemrequests**

Anyone may create an item request. The Content-Type is JSON. Example:
Anyone may create an item request (depending on backend configuration parameter `request.item.type`). The Content-Type is JSON.

Example JSON payload:

```json
{
"itemId": "71d9fb0c-cc36-41c1-b1d3-63887b414fca",
Expand All @@ -83,7 +86,11 @@ Anyone may create an item request. The Content-Type is JSON. Example:
"requestMessage": "Please send this to me."
}
```
`bitstreamId` is ignored and may be omitted if `allfiles` is `false`. `requestMessage` is optional. `requestEmail` and `requestName` are ignored and may be omitted if the session is authenticated -- these fields will be filled from the session user's EPerson. If the session is anonymous then `requestEmail` is required. `bitstreamId` is required if `allfiles` is false. `itemId` is always required.

* `bitstreamId` is ignored and may be omitted if `allfiles` is `true`. `bitstreamId` is required if `allfiles` is false.
* `itemId` is always required.
* `requestMessage` is optional.
* `requestEmail` and `requestName` are ignored and may be omitted if the session is authenticated -- these fields will be filled from the session user's EPerson. If the session is anonymous then `requestEmail` is required.

The response is empty, generated token should not be exposed.

Expand Down
Loading