Plattar Objects have a number of common operations that can be performed to interface with the Plattar API.

Sample Plattar Object
Project is one of many Plattar Objects. All Objects have a common interface.
const {
} = require('@plattar/plattar-api');

const object = new Project('your-project-id');
Plattar Object ID
The ID of Plattar Objects is assigned by the Plattar API upon creation. The ID is a unique immutable 128 bit GUID.
const id =;


// NOTE: The ID is immutable and cannot be changed = 'my id'; // ERROR
Using .get()
GET will reach out to the Plattar API and populate the object attributes. get() returns a Promise Object.
object.get().then((obj) => {}).catch((err) => {});
Using .update()
UPDATE will override the previous data with the current attributes. update() returns a Promise Object.
object.update().then((obj) => {}).catch((err) => {});
Using .create()
CREATE will generate a brand new object in the Plattar API and assign a new ID. create() returns a Promise Object.
object.create().then((obj) => {}).catch((err) => {});
Using .delete()
DELETE will remove the provided object from the Plattar API. delete() returns a Promise Object.
object.delete().then((obj) => {}).catch((err) => {});