Example 1: Creating and Preparing a Project

This workflow outlines how to set up a new project from scratch, populate it with metadata, and attach relevant files. This is a typical starting point for new projects that require consistent data inputs, such as floor plans, images, and supporting documents.

Process:

  1. Create a Project:

    • Endpoint: POST /projects

    • Action: Provide initial metadata, such as project name and description.

    • Result: Returns a new project ID for subsequent actions.

  2. Update Project Details:

    • Endpoint: PUT /projects/{id}

    • Action: Add or modify attributes like project owner, location details, or custom fields.

    • Result: Ensures the project has all necessary context before proceeding.

  3. Add Files to the Project:

    • Endpoints:

      • POST /projects/{id}/files/temporary-presigned-url (Request a URL)

      • Upload the file directly to the returned URL.

      • POST /projects/{id}/files (Register the file)

    • Action: Securely upload documents (e.g., PDFs, images) and associate them with the project.

    • Result: The project is now enriched with essential files accessible via API or UI.


Example Use Case:
A construction management app that needs to store floor plan PDFs and material lists immediately after creating a project.