Bulk Delete
is responsible for deleting multiple records
Endpoint:
/api/resources/[RESOURCE-ID]/bulk/bulkDeleteMethod: POST
Request:
recordIds- list of ids of the records to be deleted
Response:
records- list of records with resource metadatarecord- record you're requestingparams- all record dataid- record idtitle- record titlerecordActions- list all actions and their parameters available on this recordbulkActions- list of all bulk actions and their parameters available on this record
noticemessage- the message that is later displayed in the dashboardtype- a type of response, possible values aresuccess,danger,info
redirectUrl- URL that the user should be directed to after successfully edit
Example
Response:
{
"records":[
{
"params":{
"_id":"63d3af2ab1b453f9303c81d0",
"firstName":"Warren",
"lastName":"Renner",
"gender":"female",
"email":"[email protected]",
"isMyFavourite":true,
"__v":0
},
"populated":{
},
"baseError":null,
"errors":{
},
"id":"63d3af2ab1b453f9303c81d0",
"title":"[email protected]",
"recordActions":[
{
"name":"show",
"actionType":"record",
"icon":"Screen",
"label":"Show",
"resourceId":"User",
"guard":"",
"showFilter":false,
"showResourceActions":true,
"showInDrawer":false,
"hideActionHeader":false,
"containerWidth":1,
"layout":null,
"variant":"default",
"parent":null,
"hasHandler":true,
"custom":{
}
},
{
"name":"edit",
"actionType":"record",
"icon":"Edit",
"label":"Edit",
"resourceId":"User",
"guard":"",
"showFilter":false,
"showResourceActions":true,
"showInDrawer":false,
"hideActionHeader":false,
"containerWidth":1,
"layout":null,
"variant":"default",
"parent":null,
"hasHandler":true,
"custom":{
}
},
{
"name":"delete",
"actionType":"record",
"icon":"TrashCan",
"label":"Delete",
"resourceId":"User",
"guard":"Do you really want to remove this item?",
"showFilter":false,
"showResourceActions":true,
"component":false,
"showInDrawer":false,
"hideActionHeader":false,
"containerWidth":1,
"layout":null,
"variant":"danger",
"parent":null,
"hasHandler":true,
"custom":{
}
}
],
"bulkActions":[
{
"name":"bulkDelete",
"actionType":"bulk",
"icon":"Delete",
"label":"Delete all",
"resourceId":"User",
"guard":"",
"showFilter":false,
"showResourceActions":true,
"showInDrawer":true,
"hideActionHeader":false,
"containerWidth":"500px",
"layout":null,
"variant":"danger",
"parent":null,
"hasHandler":true,
"custom":{
}
}
]
},
{
"params":{
"_id":"63d3af2ab1b453f9303c81d1",
"firstName":"Jovanny",
"lastName":"Moore",
"gender":"male",
"email":"[email protected]ail.com",
"isMyFavourite":false,
"__v":0
},
"populated":{
},
"baseError":null,
"errors":{
},
"id":"63d3af2ab1b453f9303c81d1",
"title":"[email protected]",
"recordActions":[
{
"name":"show",
"actionType":"record",
"icon":"Screen",
"label":"Show",
"resourceId":"User",
"guard":"",
"showFilter":false,
"showResourceActions":true,
"showInDrawer":false,
"hideActionHeader":false,
"containerWidth":1,
"layout":null,
"variant":"default",
"parent":null,
"hasHandler":true,
"custom":{
}
},
{
"name":"edit",
"actionType":"record",
"icon":"Edit",
"label":"Edit",
"resourceId":"User",
"guard":"",
"showFilter":false,
"showResourceActions":true,
"showInDrawer":false,
"hideActionHeader":false,
"containerWidth":1,
"layout":null,
"variant":"default",
"parent":null,
"hasHandler":true,
"custom":{
}
},
{
"name":"delete",
"actionType":"record",
"icon":"TrashCan",
"label":"Delete",
"resourceId":"User",
"guard":"Do you really want to remove this item?",
"showFilter":false,
"showResourceActions":true,
"component":false,
"showInDrawer":false,
"hideActionHeader":false,
"containerWidth":1,
"layout":null,
"variant":"danger",
"parent":null,
"hasHandler":true,
"custom":{
}
}
],
"bulkActions":[
{
"name":"bulkDelete",
"actionType":"bulk",
"icon":"Delete",
"label":"Delete all",
"resourceId":"User",
"guard":"",
"showFilter":false,
"showResourceActions":true,
"showInDrawer":true,
"hideActionHeader":false,
"containerWidth":"500px",
"layout":null,
"variant":"danger",
"parent":null,
"hasHandler":true,
"custom":{
}
}
]
}
],
"notice":{
"message":"successfully removed 2 record",
"type":"success"
},
"redirectUrl":"/admin/resources/User"
}
Last modified 1mo ago