Typical API route definitions
The commands supports the CRUD (Create, read, update, delete) operations.
The CRUD definitions for table items result in following API routes (example):
| Command | Endpoint | Comment |
|---|---|---|
| GET | v1/secondhand/articles | Lists all articles with content items |
| GET | v1/secondhand/articles/:id | Lists content items of article |
| POST | v1/secondhand/articles | Creates new article with data |
| PATCH | v1/secondhand/articles/:id | Writes parameters into selected article |
| DELETE | v1/secondhand/articles/:id | Deletes selected article |
':id' has to be replaced with the article number
Attention: There is no **PUT** command support in Joomla
Examples:
??? ToDo: Get/patch/delete
Special API route definition (example)
??? Media ...
Special Endpoints:
- media
- custom fields
Custom Field endpoints
api/index.php/v1/fields/content/articles
Custom fields definitions have their own endpoints. These endpoints return the definitions of the fields (name, type, options), not the values stored in articles.
| .../v1/fields/content/articles | List all custom fields defined for articles |
| .../v1/fields/content/articles/7 | Get one custom field by ID |
| .../v1/fields/groups/content/articles | List custom field groups for articles |
| .../v1/fields/groups/content/articles/3 | Get one field group by ID |
POST, PATCH and DELETE commands are supported, so they can be created, changed or deleted