Standard Resource Endpoint
For most resources Portfoleon uses REST conventions.
| Resource action | Method | Endpoint URL | Parameters | Returns |
|---|---|---|---|---|
| List or search | GET | /api/v[1..N]/<resource_name> |
Search criteria, usually at least ?workspace_id=<workspace_id> |
JSON list of the requested objects |
| Add a new item | POST | /api/v[1..N]/<resource_name> |
New item JSON representation | JSON representation of newly created object (with id) |
| Get an item by id | GET | /api/v[1..N]/<resource_name>/<resource_id> |
None | JSON representation of the requested object |
| Update an item by id | PUT | /api/v[1..N]/<resource_name>/<resource_id> |
Updated item JSON representation | JSON representation of the updated object |
| Delete an item by id | DELETE | /api/v[1..N]/<resource_name>/<resource_id> |
None | Just the response code |
See also: