My Project
  1. Standalone Mode
My Project
  • Api Documentation
  • Standalone Mode
    • StandAlone mode
    • Models
      • Create the Model
      • Get All the models
      • Getting the child models of a parent
      • Fetching models based on user role
      • Clone model by root model Id
      • Generate Model through AI by Uploading Image for specific trained models
      • Fetching the model Attributes
      • Deleting the attributes
      • Fetching a particular model by Id
      • Creating the Model Attributes
      • Deleting A Model By Id
      • Updating a Model by Id
      • Creating the model Annotations
      • Updating the model annotation
      • Deleting the Model annotation
      • fetching the model annotations
      • Fetching the Model Components
      • Saving completion status for models
    • Projects
      • Fetching the project model components
      • Get the recent projects
      • Get the completed projects
      • Get the shared project
      • Fetching the projects
      • Creating the project
      • Fetching the project by project Id
      • Deleting the project by projectId
      • Updating the project by Id
      • Get project model
      • create project model
      • Get project Model
      • Delete Project Model
      • Update the project model
      • Skip the project model
      • Complete the project
      • Upload pdf for project model
      • Adding project model attribute
      • Get the project model component
      • Downloading pdf in project
      • Upload image and get url
      • Get project settings
    • Checklists
      • Creating the Checklist
      • Get project checklist
      • Create project checklist
      • Delete project checklist
      • Get All checklist by Project Id
      • Update project checklist
      • Reset project checklist
      • Getting the relevant checklists
      • Fetching the predefined checklists
      • Creating the predefined checklist
      • Updating the predefined checklist
      • Deleting the predefined checklist
      • Creating the checklist by uploading a csv
    • Analytics & Reporting
      • Get project analytics
      • Get project analytics data
    • Task Tracking
      • Get inspector availability
      • Create Inspector availability
      • Creating Bulk inspector availability
      • Update Inspector availability
  • Edge Mode
    • Edge Mode
    • Models
      • Create the Model
      • Get All the models
      • Getting the child models of a parent
      • Fetching models based on user role
      • Clone model by root model Id
      • Generate Model through AI by Uploading Image for specific trained models
      • Fetching the model Attributes
      • Deleting the attributes
      • Fetching a particular model by Id
      • Creating the Model Attributes
      • Deleting A Model By Id
      • Updating a Model by Id
      • Creating the model Annotations
      • Updating the model annotation
      • Deleting the Model annotation
      • fetching the model annotations
      • Fetching the Model Components
      • Saving completion status for models
    • Projects
      • Fetching the project model components
      • Get the recent projects
      • Get the completed projects
      • Get the shared project
      • Fetching the projects
      • Creating the project
      • Fetching the project by project Id
      • Deleting the project by projectId
      • Updating the project by Id
      • Get project model
      • create project model
      • Get project Model
      • Delete Project Model
      • Update the project model
      • Skip the project model
      • Complete the project
      • Upload pdf for project model
      • Adding project model attribute
      • Get the project model component
      • Downloading pdf in project
      • Upload image and get url
      • Get project settings
    • Icon
      • Creating the Icon
      • Deleting the icon
      • Get the Icons
      • Updating the Icon
      • Fetch all icons
      • Uplaod an Icon
    • Templates
      • Get template
      • Create the Template
      • Get template attributes
      • Create Template attribute
      • Delete template attribute
      • Update template attribute
      • Get template
      • Delete a Template
      • Update a template
      • Create template header
      • Get all template headers
      • Update the template header
      • Delete template header
    • Checklists
      • Creating the Checklist
      • Get project checklist
      • Create project checklist
      • Delete project checklist
      • Get All checklist by Project Id
      • Update project checklist
      • Reset project checklist
      • Getting the relevant checklists
      • Fetching the predefined checklists
      • Creating the predefined checklist
      • Updating the predefined checklist
      • Deleting the predefined checklist
      • Creating the checklist by uploading a csv
    • Annotations
      • get the annotaion
      • get annotation by Id
      • Create the annotation
      • Saving annotation in canvas
      • Updating the Annotation
      • Delete annotation by page number
      • Delete annotation
      • Get annotations with component
    • Analytics & Reporting
      • Get project analytics
      • Get project analytics data
    • Project Management Tool
      • Get project access
      • Update project access
      • Get the project model access
      • Updating the project model access
      • Delete project access
      • Get project invitation
      • send project invitation
      • Validate project invitation
      • Project Invitation Accept
      • Cancel Project Invitation
    • Task Tracking
      • Get inspector availability
      • Create Inspector availability
      • Creating Bulk inspector availability
      • Update Inspector availability
    • Estimations And Analytics
      • Fetching the project estimations
      • Creating the project estimations
      • Fetching the project estimations analytics
      • Download the project estimation analytics
      • Updating the project estimations
      • Deleting the project estimation by Id
  1. Standalone Mode

StandAlone mode

## Standalone model
Features: Models, Projects, Resources, Checklists, Timeline Reporting & Analytics, Real-time Task Tracking
Screenshot 2025-06-19 133924.png
Models
• Create the models: Creates a new base model or parent model with a structure to hold components, attributes, and annotations. Typically used as the foundational data unit within a project.
• Get all the models: Retrieves a list of all models the user has access to, including personal, shared, or project-wide models.
• Getting the child models of a parent: Returns the hierarchical children models or sub-models under a selected parent model, helping to manage nested data structures.
• Fetching models based on user role: Dynamically filters models accessible to the logged-in user based on their assigned role (e.g., inspector, manager, admin).
• Clone model by root model Id: Duplicates an entire model structure, including attributes and children, to create a new version or similar model.
• Generate Model through AI by Uploading Image: Uses a trained AI model to analyze an uploaded image (e.g., architectural drawing) and auto-generate a model with predefined sections.
• Fetching the model Attributes: Retrieves all custom metadata or user-defined fields (e.g., dimensions, material) attached to a model.
• Creating the Model Attributes: Allows creation of new metadata fields for a model such as "Type of Material", "Last Modified", or "Version Number".
• Deleting the attributes: Removes specific metadata fields or properties from a model permanently.
• Fetching a particular model by Id: Retrieves full data of a model using its unique ID, including its structure, attributes, and relationships.
• Deleting A Model By Id: Removes a specific model and optionally all of its children or associated annotations and components.
• Updating a Model by Id: Edits a model’s metadata, attributes, or structure. Useful for keeping models up to date with design or data changes.
• Creating the model Annotations: Attaches annotations to a model for documentation, tagging, or visual markup.
• fetching the model annotations: Retrieves all annotations made to a model, including type, author, date, and positioning.
• Updating the model annotation: Updates the content, placement, or style of an existing annotation linked to a model.
• Deleting the Model annotation: Permanently removes an annotation from a model by its ID.
Projects
• Fetching the project by project Id: Retrieves all details of a project including team, timelines, models, and settings using its unique identifier.
• Deleting the project by projectId: Permanently removes a project and all of its linked resources from the system.
• Updating the project by Id: Edits project-level details such as name, assigned users, deadlines, or status.
• Get project model: Retrieves models associated with a given project, helping users view project-specific architecture.
• Create project model: Adds a new model to the selected project. It becomes part of the project’s structure.
• Delete Project Model: Deletes an existing model within a project along with its data.
• Update the project model: Updates the metadata or structural information of a model inside a project.
• Skip the project model: Marks a model as skipped, indicating it will not go through the standard workflow.
• Complete the project: Updates the project status to "Completed", signaling that all workflows and tasks are done.
• Upload pdf for project model: Uploads supporting PDF documentation or schematics linked to a specific model.
• Get the project model component: Retrieves all internal components of a model such as modules, sub-sections, or zones.
• Adding project model attribute: Adds new data fields to an existing project model, extending its metadata.
• Saving completion status for models: Stores current progress or completion percentage for one or more models to track project health.
Annotations
• Get the annotation: Fetches a list of all annotations across the system or for a selected context.
• Get annotation by Id: Retrieves a specific annotation using its ID.
• Create the annotation: Creates a new annotation (e.g., markup, comment) and attaches it to a model or document.
• Saving annotation in canvas: Saves annotations drawn interactively on a visual canvas or interface, including position and shape.
• Updating the Annotation: Updates properties like content, appearance, or linked page/model of an annotation.
• Delete annotation by page number: Deletes all annotations made on a specific document page.
• Delete annotation: Deletes a single annotation record by its unique identifier.
Checklists
• Get project checklist: Retrieves task or inspection items listed for a project.
• Create project checklist: Adds new tasks or checklist items to a project to track steps or requirements.
• Delete project checklist: Removes checklist items that are no longer needed.
• Update project checklist: Edits the content, status, or deadline of existing checklist items.
• Get All checklist by Project Id: Fetches all checklist items linked to a particular project.
• Reset project checklist: Resets all checklist statuses to their default or initial state.
• Creating the Checklist: Initializes a checklist template or instance for tracking inspections, tasks, or workflows.
Analytics & Reporting
• Get project analytics: Returns summary analytics like project progress, task status, and resource use in visual formats.
• Get project analytics data: Provides raw data for use in detailed custom reporting, dashboards, or export.
Task Tracking
• Get inspector availability: Lists available time slots when inspectors are free to perform checks or audits.
• Create Inspector availability: Adds a new availability record for a specific inspector.
• Creating Bulk inspector availability: Allows adding multiple availability entries in one go, ideal for weekly or team-wide scheduling.
• Update Inspector availability: Modifies previously created availability times or changes associated details.
Modified at 2025-06-19 16:29:47
Previous
Api Documentation
Next
Models
Built with