DeleteEntities

Deletes all applicable custom entities from the server based on the custom entity type and specified delete criteria, enforcing ownership/ACL permissions.

Service	Operation
customEntity	DELETE_ENTITIES

Method Parameters

Parameter	Description
entityType	The type of custom entity being deleted.
deleteCriteria	The delete criteria to be applied.

Usage

http://localhost:3000

C#

string entityType = "athletes";
string deleteCriteria = "{\"entityId\": { \"$in\":[\"aaaa-bbbb-cccc-dddd\", \"ffff-gggg-hhhh-iiii\", \"jjjj-kkkk-llll-mmmm\"]}";
SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.CustomEntityService.DeleteEntities(entityType, deleteCriteria, successCallback, failureCallback);

C++

const char *entityType = "athletes";
const char *deleteCriteria = "{\"entityId\": { \"$in\":[\"aaaa-bbbb-cccc-dddd\", \"ffff-gggg-hhhh-iiii\", \"jjjj-kkkk-llll-mmmm\"]}";
_bc->getCustomEntityService()->deleteEntities(entityType, deleteCriteria, this);

Objective-C

NSString *entityType = @"athletes";
NSString *deleteCriteria = "{\"entityId\": { \"$in\":[\"aaaa-bbbb-cccc-dddd\", \"ffff-gggg-hhhh-iiii\", \"jjjj-kkkk-llll-mmmm\"]}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc customEntityService] deleteEntities:entityType
             deleteCriteria:deleteCriteria
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String entityType = "athletes";
string deleteCriteria = "{\"entityId\": { \"$in\":[\"aaaa-bbbb-cccc-dddd\", \"ffff-gggg-hhhh-iiii\", \"jjjj-kkkk-llll-mmmm\"]}";
this; // implements IServerCallback

_bc.getCustomEntityService().deleteEntities(entityType, deleteCriteria, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var entityType = "athletes";
var deleteCriteria = {
    "entityId": { "$in":
        ["aaaa-bbbb-cccc-dddd", "ffff-gggg-hhhh-iiii", "jjjj-kkkk-llll-mmmm"]
    }
};

_bc.customEntity.deleteEntities(entityType, deleteCriteria, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  entityType = "athletes";
var  deleteCriteria = {
    "entityId": { "$in":
        ["aaaa-bbbb-cccc-dddd", "ffff-gggg-hhhh-iiii", "jjjj-kkkk-llll-mmmm"]
    }
};

ServerResponse result = await _bc.customEntityService.deleteEntities(entityType:entityType, deleteCriteria:deleteCriteria);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

var entityType = "athletes";
var deleteCriteria = {
    "entityId": { "$in":
        ["aaaa-bbbb-cccc-dddd", "ffff-gggg-hhhh-iiii", "jjjj-kkkk-llll-mmmm"]
    }
};
var customEntityProxy = bridge.getCustomEntityServiceProxy();

var postResult = customEntityProxy.deleteEntities(entityType, deleteCriteria);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "customEntity",
    "operation": "DELETE_ENTITIES",
    "data": {
        "entityType": "athletes",
        "deleteCriteria": {
            "entityId": { "$in":
                ["aaaa-bbbb-cccc-dddd", "ffff-gggg-hhhh-iiii", "jjjj-kkkk-llll-mmmm"]
            }
        }
    }
}

JSON Response

{
  "data": {
    "deletedCount": 2
  },
  "status": 200
}