Name
Last updated on
May 15, 2021
Availability
Breeze 4
Description
Deletes one or more objects (SCOs).
If the sco-id you specify is for a folder, all the contents of the specified folder are deleted. To delete multiple SCOs, specify multiple sco-id parameters.
You can use a call such as sco-contents to check the ref-count of the SCO, which is the number of other SCOs that reference this SCO. If the SCO has no references, you can safely remove it, and the server reclaims the space.
If the SCO has references, removing it can cause the SCOs that reference it to stop working, or the server not to reclaim the space, or both. For example, if a course references a quiz presentation, removing the presentation might make the course stop working.
As another example, if a meeting has used a content SCO (such as a presentation or video), there is a reference from the meeting to the SCO. Deleting the content SCO does not free disk space, because the meeting still references it.
To delete a SCO, you need at least manage permission (see permission-id for details). Users who belong to the built-in authors group have manage permission on their own content folder, so they can delete content within it.
Request URL
http://server_name/api/xml ?action=sco-delete &sco-id=integer &session=value
Parameters
|
|
Type |
Required |
Description |
|
sco-id |
BIGINT |
Y |
The unique ID of a SCO. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> </results>
Response values
|
Element |
Attribute |
Type |
Description |
|
results |
|
Container |
All results the action returns. |
|
status |
|
Empty, with attributes |
The status of the response. |
|
|
code |
Allowed value |
A code indicating the response status (see status). |
Sample request
https://example.com/api/xml?action=sco-delete&sco-id=2007171127
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>
See also
