Project (Semantic Module)

← Back to Modules Reference

The Project semantic module is used to model project-level work containers, workspaces, or boards within your application.

While the Organization semantic models top-level multi-tenant boundaries, the Project semantic represents sub-level work containers where users collaborate on specific tasks or resources.

---

Technical Specifications

Attribute	Specification
Scope	Entity (Applied to a whole table/entity)
Has Configuration	No

---

Design Guidelines & Validation Rules

To build a valid project structure, the platform enforces the following guidelines:

1. User Entity Requirement: A Project entity typically connects to a User entity to manage collaborators.
2. Project Membership Link: The Project entity can have a relationship marked with ProjectMembers pointing to the User entity to track project members and their access roles.

---

Configuring in the Domain Modeler

To designate an entity as a Project in the user interface:

1. Open the Domain Modeler and select the entity representing your project (e.g., Project or Workspace).
2. In the entity details panel, locate the Semantic Module dropdown and select Project.
3. Save your changes.

---

Runtime Behavior

The Serverless Engine uses the Project semantic module to structure scoped API endpoints (e.g., /projects/{projectId}/tasks) and verify user access through the associated ProjectMembers membership link.