ReportInstance.php
This api exposes CiviCRM report instances.
Table of Contents
Functions
- civicrm_api3_report_instance_get() : array<string|int, mixed>
- Retrieve a report instance.
- civicrm_api3_report_instance_create() : array<string|int, mixed>
- Add or update a report instance.
- _civicrm_api3_report_instance_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_report_instance_delete() : array<string|int, mixed>
- Deletes an existing ReportInstance.
Functions
civicrm_api3_report_instance_get()
Retrieve a report instance.
civicrm_api3_report_instance_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Return values
array<string|int, mixed> —API result array
civicrm_api3_report_instance_create()
Add or update a report instance.
civicrm_api3_report_instance_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
_civicrm_api3_report_instance_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_report_instance_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_report_instance_delete()
Deletes an existing ReportInstance.
civicrm_api3_report_instance_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array