Developer Function: Script: $p.apiBulkDelete
## Overview
This script function allows you to bulk delete records using an Ajax POST request.
## How to Use
##### JavaScript
```
$p.apiBulkDelete({
id: <Site ID>,
data: {
<data>
},
done: <any operation>,
fail: <any operation>,
always: <any operation>
});
```
## Description of Each Parameter
|Parameter name|Description|
|:--|:--|
|Site ID|Site ID of the table in which the record to be deleted is registered|
|Data|json to be POSTed|
|Any operation|Processing when API communication is successful (done: required), when it fails (fail: optional), when it is completed (always: optional)|
## How to Write
#### When deleting records by filtering by column conditions
##### JavaScript
```
$p.apiBulkDelete({
id: 123,
data: {
View: {
ColumnFilterHash: {
Status: "[100,910]"
}
}
},
done: function (data) {
console.log(data);
},
fail: function (data) {
console.log(data);
},
always: function (data) {
console.log(data);
}
});
```
#### When deleting multiple specified records (deleting records with record IDs 135,376)
##### JavaScript
```
$p.apiBulkDelete({
id: 123,
data: {
Selected: [
135,
376
]
},
done: function (data) {
console.log(data);
},
fail: function (data) {
console.log(data);
},
always: function (data) {
console.log(data);
}
});
```
#### When deleting all records in the target table
##### JavaScript
```
$p.apiBulkDelete({
id: 123,
data: {
All: true
},
done: function (data) {
console.log(data);
},
fail: function (data) {
console.log(data);
},
always: function (data) {
console.log(data);
}
});
```
#### When deleting records checked on the list screen
##### JavaScript
```
$p.apiBulkDelete({
id: 123,
data: {
GridCheck: true
},
done: function (data) {
console.log(data);
},
fail: function (data) {
console.log(data);
},
always: function (data) {
console.log(data);
}
});
```
#### When physically deleting records checked on the list screen
##### JavaScript
```
$p.apiBulkDelete({
id: 123,
data: {
GridCheck: true,
PhysicalDelete: true
},
done: function (data) {
console.log(data);
},
fail: function (data) {
console.log(data);
},
always: function (data) {
console.log(data);
}
});
```
