Skip to content
Snippets Groups Projects
Commit 584f9aa4 authored by Seamus Lee's avatar Seamus Lee
Browse files

Add in APIv4 Actions documentation

parent 45387a16
No related branches found
No related tags found
1 merge request!692Add in APIv4 Actions documentation
# API Actions
# APIv3 Actions
Most entities support the following actions:
......
# APIv4 Actions
Most entities support the following actions:
## create
Insert one records into the database.
## Update
Update a record in the database.
## delete
Delete one or more records. (Note: Requires an explicit `id`. Note: if you want to skip the 'recycle bin' for entities that support undelete (e.g. contacts) you should set `$param['skip_undelete'] => 1);`
## get
Search for records
## getfields
Fetch entity metadata, i.e. the list of fields supported by the entity
## replace
Replace an old set of records with a new or modified set of records. (For example, replace the set of "Phone" numbers with a different set of "Phone" numbers.).
Warning - REPLACE includes an implicit delete - use with care & test well before using in productions
## Save
Create or update one or more records
......@@ -50,7 +50,7 @@ pages:
- API Interfaces: api/interfaces.md
- APIv4:
- APIv4 Usage: api/v4/usage.md
# - APIv4 Actions: api/v4/actions.md
- APIv4 Actions: api/v4/actions.md
# - APIv4 Options: api/v4/options.md
# - APIv4 Joins: api/v4/joins.md
# - APIv4 Chaining: api/v4/chaining.md
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment