EntityBatch.php
This api exposes CiviCRM EntityBatch records.
Use this api to add/remove entities from a batch. To create/update/delete the batches themselves, use the Batch api.
Table of Contents
Functions
- civicrm_api3_entity_batch_get() : array<string|int, mixed>
- Get entity batches.
- _civicrm_api3_entity_batch_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_entity_batch_create() : array<string|int, mixed>
- Create an entity batch.
- civicrm_api3_entity_batch_delete() : array<string|int, mixed>
- Mark entity batch as removed.
Functions
civicrm_api3_entity_batch_get()
Get entity batches.
civicrm_api3_entity_batch_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_entity_batch_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_entity_batch_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_entity_batch_create()
Create an entity batch.
civicrm_api3_entity_batch_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_entity_batch_delete()
Mark entity batch as removed.
civicrm_api3_entity_batch_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>