Save Document Studio Report

Save a document studio report with rich formatting, dynamic content, and automatic version management. This endpoint creates a new version of the report each time it’s called, maintaining a complete version history.

Path Parameters

projectId

string

required

The unique identifier of the project associated with the report

Request Body

reportName

string

required

The name of the report. This serves as a unique identifier within the project scope.

content

object

required

The complete report content structure including blocks, formatting, and data

Show content structure

blocks

array

required

Array of content blocks that make up the report

Show block types

type

string

required

Type of content block: “title”, “narrative”, “data”, “table”, “section”, “list”

content

string

The actual content of the block (for text-based blocks)

properties

object

Block-specific properties and configuration

Show common properties

sectionId

string

Unique identifier for the section (used for narrative blocks)

title

string

Display title for the block

required

boolean

Whether this block requires content (for templates)

fontSize

string

Font size (e.g., “16px”, “1.2em”)

textAlign

string

Text alignment: “left”, “center”, “right”, “justify”

color

string

Text color (hex code or CSS color name)

children

array

Child blocks (for section-type blocks)

metadata

object

Report metadata and configuration

Show metadata

templateId

string

ID of the template this report is based on

reportType

string

Type of report: “GENERAL”, “INITIAL”, “INTERIM”, “FINAL”

author

string

Author of the report

lastModified

string

ISO timestamp of last modification

Example Request

{
  "reportName": "Q2 Progress Report",
  "content": {
    "blocks": [
      {
        "type": "title",
        "content": "Quarterly Progress Report",
        "properties": {
          "fontSize": "24px",
          "textAlign": "center",
          "color": "#2c3e50"
        }
      },
      {
        "type": "section",
        "properties": {
          "title": "Executive Summary"
        },
        "children": [
          {
            "type": "narrative",
            "properties": {
              "sectionId": "executive-summary",
              "title": "Project Overview",
              "required": true
            },
            "content": "<p>The project has made significant progress during Q2 2024, with major milestones achieved in foundation work and structural development.</p>"
          }
        ]
      },
      {
        "type": "data",
        "properties": {
          "title": "Financial Summary",
          "dataSource": "project.financials",
          "format": "currency"
        }
      },
      {
        "type": "table",
        "properties": {
          "title": "Risk Assessment Summary",
          "dataSource": "project.riskAssessments",
          "columns": [
            {"key": "category", "title": "Risk Category"},
            {"key": "status", "title": "Current Status"},
            {"key": "notes", "title": "Notes"}
          ]
        }
      },
      {
        "type": "list",
        "properties": {
          "sectionId": "key-achievements",
          "title": "Key Achievements",
          "listType": "bullet"
        },
        "content": "Foundation work completed ahead of schedule\nSteel frame installation commenced\nAll safety milestones met"
      }
    ],
    "metadata": {
      "templateId": "template-001",
      "reportType": "INTERIM",
      "author": "Project Surveyor",
      "lastModified": "2024-06-20T14:30:00.000Z"
    }
  }
}

Response

Returns the saved report information including the new version number:

reportId

string

Unique identifier of the report

version

number

Version number of the newly created version

Example Response

{
  "reportId": "report-12345",
  "version": 3
}

Block Types Reference

Title Block

Used for report titles and major headings:

{
  "type": "title",
  "content": "Report Title",
  "properties": {
    "fontSize": "24px",
    "textAlign": "center",
    "color": "#333333"
  }
}

Narrative Block

For rich text content with editing capabilities:

{
  "type": "narrative",
  "properties": {
    "sectionId": "unique-section-id",
    "title": "Section Title",
    "required": true
  },
  "content": "<p>Rich HTML content with <strong>formatting</strong></p>"
}

Data Block

For dynamic project data integration:

{
  "type": "data",
  "properties": {
    "title": "Project Costs",
    "dataSource": "project.costs.total",
    "format": "currency",
    "calculation": "sum"
  }
}

Table Block

For structured data presentation:

{
  "type": "table",
  "properties": {
    "title": "Cost Breakdown",
    "dataSource": "project.facilities",
    "columns": [
      {"key": "name", "title": "Facility"},
      {"key": "budget", "title": "Budget", "format": "currency"},
      {"key": "actual", "title": "Actual", "format": "currency"}
    ]
  }
}

Section Block

For organizing content into logical sections:

{
  "type": "section",
  "properties": {
    "title": "Financial Analysis"
  },
  "children": [
    // Child blocks go here
  ]
}

List Block

For bullet points and numbered lists:

{
  "type": "list",
  "properties": {
    "sectionId": "achievements",
    "title": "Key Achievements",
    "listType": "bullet"
  },
  "content": "Item 1\nItem 2\nItem 3"
}

Version Management

Document Studio automatically manages versions:

Auto-Increment: Each save creates a new version with incremented number
Version History: Complete history is maintained for all versions
No Overwrites: Previous versions are never lost or modified
Timestamp Tracking: Each version includes creation timestamp
User Attribution: Version changes are tracked by user

Content Validation

The system validates report content:

Block Structure: Ensures all blocks have required properties
Data References: Validates that data sources exist and are accessible
HTML Safety: Sanitizes HTML content in narrative blocks
Required Fields: Checks that required narrative sections have content
JSON Schema: Validates overall content structure against schema

Integration with Templates

Reports can be based on templates:

Template Inheritance: Reports inherit structure from templates
Custom Modifications: Template-based reports can be customized
Required Sections: Template requirements are enforced
Dynamic Content: Template placeholders are populated with project data

Error Responses

400

error

Bad Request - Invalid content structure or missing required fields

{
  "statusCode": 400,
  "message": "Invalid block structure",
  "error": "Bad Request"
}

404

error

Not Found - Project not found or user lacks access

{
  "statusCode": 404,
  "message": "Project not found",
  "error": "Not Found"
}

413

error

Payload Too Large - Report content exceeds size limits

{
  "statusCode": 413,
  "message": "Report content too large",
  "error": "Payload Too Large"
}

Best Practices

Unique Section IDs: Use consistent, unique section IDs for narrative blocks
Structured Content: Organize content logically using section blocks
Data Integration: Leverage data blocks for dynamic project information
Regular Saves: Save frequently to maintain version history
Content Validation: Validate required sections before final save
Template Consistency: Follow template structures when applicable

Get Report - Retrieve a specific report version
List Report Versions - View version history
Export Report - Export as PDF

API Documentation

Analytics

Projects

Reports

Document Studio

Benchmarking

Community

Save Document Studio Report

Path Parameters

Request Body

Example Request

Response

Example Response

Block Types Reference

Title Block

Narrative Block

Data Block

Table Block

Section Block

List Block

Version Management

Content Validation

Integration with Templates

Error Responses

Best Practices

API Documentation

Analytics

Projects

Reports

Document Studio

Benchmarking

Community

​Path Parameters

​Request Body

​Example Request

​Response

​Example Response

​Block Types Reference

​Title Block

​Narrative Block

​Data Block

​Table Block

​Section Block

​List Block

​Version Management

​Content Validation

​Integration with Templates

​Error Responses

​Best Practices

​Related Endpoints

Path Parameters

Request Body

Example Request

Response

Example Response

Block Types Reference

Title Block

Narrative Block

Data Block

Table Block

Section Block

List Block

Version Management

Content Validation

Integration with Templates

Error Responses

Best Practices

Related Endpoints