3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+ */
12 * This api exposes CiviCRM EntityBatch records.
14 * Use this api to add/remove entities from a batch.
15 * To create/update/delete the batches themselves, use the Batch api.
17 * @package CiviCRM_APIv3
23 * @param array $params
27 function civicrm_api3_entity_batch_get($params) {
28 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
32 * Adjust Metadata for Create action.
34 * The metadata is used for setting defaults, documentation & validation.
36 * @param array $params
37 * Array of parameters determined by getfields.
39 function _civicrm_api3_entity_batch_create_spec(&$params) {
40 $params['entity_id']['api.required'] = 1;
41 $params['batch_id']['api.required'] = 1;
45 * Create an entity batch.
47 * @param array $params
51 function civicrm_api3_entity_batch_create($params) {
52 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'EntityBatch');
56 * Mark entity batch as removed.
58 * @param array $params
62 function civicrm_api3_entity_batch_delete($params) {
63 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);