Note.php
This api exposes CiviCRM note.
Table of Contents
Functions
- civicrm_api3_note_create() : array<string|int, mixed>
- Create Note.
- _civicrm_api3_note_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_note_delete() : array<string|int, mixed>
- Deletes an existing note.
- civicrm_api3_note_get() : array<string|int, mixed>
- Retrieve a specific note or notes, given a set of input params.
- _civicrm_api3_note_get_spec() : mixed
- Adjust Metadata for Get action.
- civicrm_api3_note_tree_get() : array<string|int, mixed>
- Get all descendants of given note.
- _civicrm_api3_note_deprecation() : array<string|int, mixed>
- Declare deprecated api functions.
Functions
civicrm_api3_note_create()
Create Note.
civicrm_api3_note_create(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for creating a note. Required parameters : entity_id AND note
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value property values of civicrm_note.
Return values
array<string|int, mixed> —API result array
_civicrm_api3_note_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_note_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_note_delete()
Deletes an existing note.
civicrm_api3_note_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for deleting a note
Parameters
- $params : array<string|int, mixed>
-
Including id of the note to be deleted.
Return values
array<string|int, mixed>civicrm_api3_note_get()
Retrieve a specific note or notes, given a set of input params.
civicrm_api3_note_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Return values
array<string|int, mixed> —array of properties, if error an array with an error id and error message
_civicrm_api3_note_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_note_get_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_note_tree_get()
Get all descendants of given note.
civicrm_api3_note_tree_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
array; only required 'id' parameter is used.
Return values
array<string|int, mixed> —Nested associative array beginning with direct children of given note.
_civicrm_api3_note_deprecation()
Declare deprecated api functions.
_civicrm_api3_note_deprecation() : array<string|int, mixed>