Form API Endpoints - Coming Soon 🎉
The Form API provides powerful tools to create, manage, and assign custom forms within the magicplan ecosystem. These forms can be dynamically attached to various project contexts — such as an entire plan, specific rooms, walls, or objects — enabling seamless data collection, QA processes, or tailored field workflows.
This upcoming API will enable developers to programmatically manage form lifecycles via RESTful endpoints.
🧠 All forms follow a validated schema to ensure compatibility with magicplan’s internal floorplan and object modeling engines. The schema supports nested elements, context targeting, and custom extension capabilities.
🚀 Upcoming EndpointsCopied!
The initial release of the Form API will include the following operations:
1. List FormsCopied!
GET /forms
Retrieve all forms available in the workspace.
2. Get a Form by IDCopied!
GET /forms/{id}
Fetch the complete structure of a form using its unique identifier.
3. Create a New FormCopied!
POST /forms
Create a new form based on a predefined schema, including:
-
name– A descriptive title for the form -
context– One or more applicable contexts (e.g.,plan,floor,room,objectsTree) -
children– The structural elements of the form (e.g., sections and questions)
4. Update an Existing FormCopied!
PUT /forms/{id}
Update an existing form’s metadata or structure, including its context or nested form elements.
5. Delete a FormCopied!
DELETE /forms/{id}
Permanently delete a form from the workspace.
This action is irreversible.
🔜 🧭 Planned EndpointsCopied!
The following endpoints are part of our extended roadmap and will be introduced in upcoming updates:
6. Form Context OptionsCopied!
Retrieve the list of available context options — including custom room types and object categories — for dynamic form assignment.
7. Publish a FormCopied!
Make a form active and available for use across projects in the workspace.
8. Unpublish a FormCopied!
Temporarily deactivate a form without deleting it. Ideal for archiving or testing workflows.