Skip to content
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.

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

Workspace Items: add description of DELETE method #277

Merged
merged 1 commit into from
Aug 27, 2024
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
9 changes: 9 additions & 0 deletions workspaceitems.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,15 @@ It would respond with:
* 403 Forbidden - if you are not logged in with sufficient permissions to view the workspace item
* 204 if the workspace item doesn't exist

## DELETE Method

**/api/submission/workspaceitems/<:ws-item-uuid>**

Deletes workspace item with the given UUID. The deletion includes the deletion of the item object that is associated to the given workspace item.

Available Response Codes are

* 204 No content - if the operation succeed
* 401 Unauthorized - if the requester is not authenticated
* 403 Forbidden - if the requester does not have sufficient permissions ((deletion of workspace items can only be requested by the submitter of the workspace item or administrators)
* 404 Not found - if the workspace item doesn't exist