REST Conventions

Catalyst follows following conventions when creating and maintaining REST endpoints. These are not hard written rules, rather the summary of best practices that will enable building of cleaner, concise and more maintainable REST APIs.

Get All

[GET] /samples

Get by Id

[GET] /samples/{id}

Get by Filter

[GET] /samples?filters={"field1":"value1", "field2": "value2", ...}

The filter is a serialized JSON object that can be mapped to a filter object in the service

Create

[POST] /samples

Edit

[PUT] /samples/{id}

Delete

[DELETE] /samples/{id}