Skip to end of metadata
Go to start of metadata

API Builder 3.x is deprecated


Support for API Builder 3.x ceased on 30 April 2020. Use the v3 to v4 upgrade guide to migrate all your applications to API Builder 4.x.

Contact if you require migration assistance.

Any callback in the application that is passed the request object can access the Models programmatically. If the actions property in the model definition is set, some of the methods cannot be invoked. The actions property restricts which CRUD operations can be invoked on the models.

  1. Retrieve an instance to API Builder using the request.server property.
  2. Retrieve the Model instance using API Builder's getModel('name') method by passing it the name of the model.
  3. Invoke one of the following methods on the Model instance and pass it a callback function, which is passed an error and results object:


The Route example below retrieves all car model.