v8 (v7 Rails v1 Django)
Getting Started
Reference Guide
Default routes
⚠️ This page is relevant only if you installed Forest Admin directly on a database (SQL/Mongodb). If you installed in a Rails app, the default routes are managed within your Rails app.
Forest Admin's default routes are generated in the
routes folder at installation.Below we've detailed what the
next() statement does. Those snippets can be used when overriding those routes, as explained here.Create a record
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordCreator,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Create a Company - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#create-a-record
14
router.post('/companies', permissionMiddlewareCreator.create(), (request, response, next) => {
15
const { body, query, user } = request;
16
const recordCreator = new RecordCreator(companies, user, query);
17
18
recordCreator.deserialize(body)
19
.then(recordToCreate => recordCreator.create(recordToCreate))
20
.then(record => recordCreator.serialize(record))
21
.then(recordSerialized => response.send(recordSerialized))
22
.catch(next);
23
});
24
25
...
Copied!
Update a record
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordUpdater,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Update a Company - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#update-a-record
14
router.put('/companies/:recordId', permissionMiddlewareCreator.update(), (request, response, next) => {
15
const { body, params, query, user } = request;
16
const recordUpdater = new RecordUpdater(companies, user, query);
17
18
recordUpdater.deserialize(body)
19
.then(recordToUpdate => recordUpdater.update(recordToUpdate, params.recordId))
20
.then(record => recordUpdater.serialize(record))
21
.then(recordSerialized => response.send(recordSerialized))
22
.catch(next);
23
});
24
25
...
Copied!
Delete a record
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordRemover,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Delete a Company - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#delete-a-record
14
router.delete('/companies/:recordId', permissionMiddlewareCreator.delete(), (request, response, next) => {
15
const { params, query, user } = request;
16
const recordRemover = new RecordRemover(companies, user, query);
17
18
recordRemover.remove(params.recordId)
19
.then(() => response.status(204).send())
20
.catch(next);
21
});
22
23
...
Copied!
Get a list of records
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordsGetter,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Get a list of Companies - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#get-a-list-of-records
14
router.get('/companies', permissionMiddlewareCreator.list(), (request, response, next) => {
15
const { query, user } = request;
16
const recordsGetter = new RecordsGetter(companies, user, query);
17
18
recordsGetter.getAll()
19
.then(records => recordsGetter.serialize(records))
20
.then(recordsSerialized => response.send(recordsSerialized))
21
.catch(next);
22
});
23
24
...
Copied!
Get a number of records
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordsCounter,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Get a number of Companies - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#get-a-number-of-records
14
router.get('/companies/count', permissionMiddlewareCreator.list(), (request, response, next) => {
15
const { query, user } = request;
16
const recordsCounter = new RecordsCounter(companies, user, query);
17
18
recordsCounter.count(request.query)
19
.then(count => response.send({ count }))
20
.catch(next);
21
});
22
23
...
Copied!
Get a record
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordGetter,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Get a Company - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#get-a-record
14
router.get('/companies/:recordId', permissionMiddlewareCreator.details(), (request, response, next) => {
15
const { params, query, user } = request;
16
const recordGetter = new RecordGetter(companies, user, query);
17
18
recordGetter.get(params.recordId)
19
.then(record => recordGetter.serialize(record))
20
.then(recordSerialized => response.send(recordSerialized))
21
.catch(next);
22
});
23
Copied!
Export a list of records
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordsExporter,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Export a list of Companies - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#export-a-list-of-records
14
router.get('/companies.csv', permissionMiddlewareCreator.export(), (request, response, next) => {
15
const { query, user } = request;
16
const recordsExporter = new RecordsExporter(companies, user, query);
17
18
recordsExporter
19
.streamExport(response)
20
.catch(next);
21
});
Copied!
Delete a list of records
/routes/companies.js
1
...
2
3
const {
4
PermissionMiddlewareCreator,
5
RecordsRemover,
6
} = require('forest-express-sequelize');
7
const { companies } = require('../models');
8
9
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
10
11
...
12
13
// Delete a list of Companies - Check out our documentation for more details: https://docs.forestadmin.com/documentation/v/v6/reference-guide/routes/default-routes#delete-a-record
14
router.delete('/companies', permissionMiddlewareCreator.delete(), (request, response, next) => {
15
const { query, user } = request;
16
17
const recordsGetter = new RecordsGetter(companies, user, query);
18
const recordsRemover = new RecordsRemover(companies, user, query);
19
20
recordsGetter.getIdsFromRequest(request)
21
.then((ids) => recordsRemover.remove(ids))
22
.then(() => response.status(204).send())
23
.catch(next);
24
});
Copied!
Other available routes
Some other routes exist but are not generated automatically because it's less likely that you'll need to extend or override them.
Here is the list:
Relationship routes
GET /forest/{modelName}/{id}/relationships/{hasManyRelationName}
⟶ List has many relationships
GET /forest/{modelName}/{id}/relationships/{hasManyRelationName}/count
⟶ Count has many relationships
PUT /forest/{modelName}/{id}/relationships/{belongsToRelationName}
⟶ Update a belongs to field
POST /forest/{modelName}/{id}/relationships/{hasManyRelationName}
⟶ Add existing records to has many relationship
GET /forest/{modelName}/{id}/relationships/{hasManyRelationName}.csv
⟶ Export all has many relationships
PUT /forest/{modelName}/{id}/relationships/{embeddedRelationName}/{index}
⟶ Update an embedded document (inside a list)
DELETE /forest/{modelName}/{id}/relationships/{hasManyRelationName}
⟶ Dissociate records from relations
Action routes
POST /forest/actions/{actionNameDasherized}/values
⟶ Get the default values for this action
Last modified 5mo ago