EntityDeleteAllResponse
EntityDeleteAllResponse
Section titled “EntityDeleteAllResponse”Schema definition for EntityDeleteAllResponse
Schema Viewer
Section titled “Schema Viewer”EntityDeleteAllResponse
entityIdsarrayrequired
IDs the delete attempted, when verbose was requested; an id whose delete failed also appears in errorsById. Empty when verbose is false.
errorsByIdobject
Collections of errors by ids if any.
modelIdstringrequired
ID of the model.
numDeletedintegerrequired
Number of the deleted entities.
requestIdstringrequired
ID of the original request to get data.
Description
Section titled “Description”This schema defines the structure and validation rules for EntityDeleteAllResponse.
Properties
Section titled “Properties”- entityIds (array, required): IDs the delete attempted, when verbose was requested; an id whose delete failed also appears in errorsById. Empty when verbose is false.
- errorsById (object): Collections of errors by ids if any.
- modelId (string, required): ID of the model.
- numDeleted (integer, required): Number of the deleted entities.
- requestId (string, required): ID of the original request to get data.
Related Schemas
Section titled “Related Schemas”See other schemas in the entity category.