Create (blueprint)
Create a new record in your database.
POST /:model
Responds with a JSON dictionary representing the newly created instance. If a validation error occurred, a JSON response with the invalid attributes and a 400 status code will be returned instead.
Additionally, if the autoWatch setting is on (which it is by default), then a "created" notification will be published to all client sockets which are watching this model; that is, client sockets who have previously sent a request to the "Find" blueprint action. Those same sockets will also be subscribed to hear about subsequent changes to the new record.
Finally, if this blueprint action is triggered via a socket request, then the requesting socket will ALSO be subscribed to the newly created record. In other words, if the record is subsequently updated or deleted using blueprints, a message will be sent to that client socket informing them of the change. See .subscribe() for more info.
Parameters
Parameters should be sent in the request body. By default, Sails understands the most common types of encodings for body parameters, including url-encoding, form-encoding, and JSON.
| Parameter | Type | Details |
|---|---|---|
| model | The identity of the model in which the new record should be created. e.g. 'purchase' (in POST /purchase) |
|
| _*_ | Send body parameters with the same names as the attribute defined on your model to set those values on your new record. These values are handled the same way as if they were passed into the model's .create() method. |
Example
Create a new user named "Applejack" with a hobby of "pickin", who is involved in purchases #13 and #25:
POST /pony
{
"name": "Applejack",
"hobby": "pickin",
"involvedInPurchases": [13,25]
}
Example response
{
"id": 47,
"name": "Applejack",
"hobby": "pickin",
"createdAt": 1485550575626,
"updatedAt": 1485550603847,
"involvedInPurchases": [
{
"id": 13,
"amount": 10000,
"createdAt": 1485550525451,
"updatedAt": 1485550544901
},
{
"id": 25,
"amount": 4.50,
"createdAt": 1485550561340,
"updatedAt": 1485550561340
}
]
}
Socket notifications
If you have WebSockets enabled for your app, then every socket client who is "watching" this model (has sent a request to the model's "find where" blueprint action) will receive a "created" notification where the event name is the model identity (e.g. user), and the message has the following format:
verb: 'created',
data: <a dictionary of the attribute values of the new record (without associations)>
id: <the new record primary key>,
For instance, continuing the example above, all clients who are watching the User model (except for the client making the request) would receive the following message:
id: 47,
verb: 'created',
data: {
id: 47,
name: 'Applejack',
hobby: 'pickin',
createdAt: 1485550575626,
updatedAt: 1485550603847
}
Clients subscribed to newly-associated child records will receive a notification, too:
Since the new record in our example included an initial value for involvedInPurchases, an association pointed at by via on the other side, then addedTo notifications would also be sent to any clients who are subscribed to those now-associated child records on the other side of the relationship—in this case, purchases 13 and 25. See Blueprints > add to for more info about the structure of those notifications.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.