POST
Recordings.ScreenDelete
Remove one screen recording from a mission by its recording_index. The route updates the mission, runs the recording deletion automation event, and sends the realtime socket event.
Permissions
- User must be logged in with a valid bearer token.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Runs the Recordings.ScreenDelete function and returns JSON.
Push Service
Pushes event recordings.screen_deleted to users who should see this change.
Automation
Runs automation event recordings.screen_deleted with the record id and submitted parameters after the action succeeds.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- Send parameters as POST body fields exactly as documented.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
mission_idpost | int | 500 | Mission id that owns the screen recording. The user must have permission to edit this mission. |
recording_indexpost | int | 0 | Zero-based index from Recordings.ScreenList.data[].recording_index. data_id is also accepted. |
Optional Parameters
No optional body parameters are defined for this function.
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Recordings.ScreenDelete",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"mission_id": "500",
"recording_index": "0"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Recordings.ScreenDelete",
"url_domain": "https:\/\/{domain}\/app\/Recordings.ScreenDelete"
}Endpoint
POST /app/Recordings.ScreenDelete
POST https://{user}.bull36.com/app/Recordings.ScreenDelete
POST https://{domain}/app/Recordings.ScreenDeleteSample Output
{
"success": 1,
"message": "Success",
"mission_id": 500,
"count": 0,
"data": [],
"automation_event": "recordings.screen_deleted",
"socket_event": "recordings.screen_deleted"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ mission_id: '500', recording_index: '0' });
const res = await fetch('/app/Recordings.ScreenDelete', { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body });
const data = await res.json();
console.log(data);Error Example
{
"success": "0",
"message": "Screen recording index was not found."
}