{ "openapi": "3.0.0", "info": { "title": "Preimage REST API", "version": "2.0.0", "description": "Selected workspace, project, scan, report, and virtual tour operations. Authenticate with a REST bearer token." }, "servers": [ { "url": "https://api.preimage.ai/v2" } ], "security": [ { "bearerAuthToken": [] } ], "tags": [ { "name": "Workspaces" }, { "name": "Projects" }, { "name": "Scans" }, { "name": "Scan Report" }, { "name": "Floor" }, { "name": "Transfers" }, { "name": "Virtual-Tour" } ], "paths": { "/workspace": { "get": { "summary": "List user workspaces", "tags": [ "Workspaces" ], "security": [ { "bearerAuthToken": [] } ], "responses": { "200": { "description": "Workspaces retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "ADMIN", "WRITER", "CONTRIBUTOR" ] } } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_workspace" } }, "/workspace/projects/{workspaceId}": { "get": { "summary": "List workspace projects", "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Projects retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer" }, "perPage": { "type": "integer" }, "total": { "type": "integer" }, "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "projectName": { "type": "string" }, "allscan": { "type": "array", "items": { "type": "object", "properties": { "projectname": { "type": "string" }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "scanId": { "type": "string" }, "title": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "color": { "type": "string" } } } } } } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_workspace_projects_workspaceId" } }, "/workspace/{workspaceId}/timeline": { "get": { "summary": "Get workspace timeline", "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variant", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "month", "range" ] } }, { "name": "date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "dateRange.start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "dateRange.end", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Timeline retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" } } }, "allScans": { "type": "array", "items": { "type": "object", "properties": { "projectname": { "type": "string" }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "scanId": { "type": "string" }, "title": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "color": { "type": "string" } } } }, "projectWiseScans": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "projectName": { "type": "string" }, "allscan": { "type": "array", "items": { "type": "object", "properties": { "projectname": { "type": "string" }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "scanId": { "type": "string" }, "title": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "color": { "type": "string" } } } } } } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_workspace_workspaceId_timeline" } }, "/workspace/stats/{workspaceId}": { "get": { "summary": "Get workspace statistics", "tags": [ "Workspaces" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Statistics retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "projectCount": { "type": "integer" }, "userCount": { "type": "integer" }, "scanCount": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_workspace_stats_workspaceId" } }, "/workspace/users/{workspaceId}": { "get": { "summary": "List workspace users", "tags": [ "Workspaces" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Users retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "ADMIN", "WRITER", "CONTRIBUTOR" ] }, "email": { "type": "string" }, "name": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_workspace_users_workspaceId" } }, "/project": { "post": { "summary": "Create a new project", "tags": [ "Projects" ], "security": [ { "bearerAuthToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "workspaceId", "name" ], "properties": { "workspaceId": { "type": "string", "description": "ID of the workspace where project will be created" }, "name": { "type": "string", "description": "Name of the project" }, "description": { "type": "string", "description": "Project description" }, "metadata": { "type": "object", "description": "Additional project metadata" } } } } } }, "responses": { "201": { "description": "Project created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "workspaceId": { "type": "string" }, "public": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "currentGlobalTransformationId": { "type": "string" }, "metadata": { "type": "object" } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "post_project" } }, "/project/{projectId}": { "get": { "summary": "Get project details", "tags": [ "Projects" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "description": "The ID of the project to retrieve", "schema": { "type": "string" } }, { "name": "workspace", "in": "query", "required": false, "description": "The slug of the workspace. If provided, project access will be validated within this workspace", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Project details retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "workspaceId": { "type": "string" }, "public": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "currentGlobalTransformationId": { "type": "string" }, "metadata": { "type": "object" } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_project_projectId" }, "patch": { "summary": "Update project details", "tags": [ "Projects" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "description": "The ID of the project to update", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "New project name" }, "description": { "type": "string", "description": "New project description" }, "public": { "type": "boolean", "description": "Project visibility status" }, "workspaceId": { "type": "string", "description": "New workspace ID if moving project" }, "currentGlobalTransformationId": { "type": "string", "description": "Current global transformation ID" } } } } } }, "responses": { "200": { "description": "Project updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "workspaceId": { "type": "string" }, "public": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "currentGlobalTransformationId": { "type": "string" }, "metadata": { "type": "object" } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "patch_project_projectId" }, "delete": { "summary": "Delete a project", "tags": [ "Projects" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "description": "The ID of the project to delete", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Project deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "workspaceId": { "type": "string" }, "public": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "currentGlobalTransformationId": { "type": "string" }, "metadata": { "type": "object" } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "delete_project_projectId" } }, "/project/{projectId}/upload-url": { "post": { "summary": "Get signed URL for file upload", "tags": [ "Projects" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "description": "The ID of the project", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "filename", "format" ], "properties": { "filename": { "type": "string", "description": "Name of the file to upload" }, "type": { "type": "string", "enum": [ "floorplan" ], "description": "Type of file being uploaded" }, "format": { "type": "string", "enum": [ "pdf", "img" ], "description": "Format of the file" } } } } } }, "responses": { "200": { "description": "Upload URL generated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "post_project_projectId_upload_url" } }, "/project/scans/{projectId}": { "get": { "summary": "Get project scans", "tags": [ "Projects" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "description": "The ID of the project to retrieve scans for", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page number for pagination", "schema": { "type": "integer" } }, { "name": "perPage", "in": "query", "required": false, "description": "Number of items per page", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project scans retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer" }, "perPage": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "status": { "type": "string" }, "thumbnailUrl": { "type": "string" }, "input": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "object", "properties": { "transfer": { "type": "object" } } } } } }, "outputs": { "type": "object", "properties": { "outputParts": { "type": "array", "items": { "type": "object" } }, "virtualTour": { "type": "object" } } } } } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_project_scans_projectId" } }, "/projects/{projectId}/floors": { "get": { "summary": "Get Floors", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "s3Url": { "type": "string" }, "transformationMatrix": { "type": "array", "items": { "type": "number" } }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } }, "metadata": { "type": "object" }, "isLocal": { "type": "boolean" }, "autodeskUrn": { "type": "string" } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "get_projects_projectId_floors" } }, "/scan": { "post": { "summary": "Create a new scan", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "projectId", "scanDate", "input", "outputs" ], "properties": { "projectId": { "type": "string", "description": "ID of the project to create scan in" }, "description": { "type": "string", "description": "Optional description of the scan" }, "scanDate": { "type": "string", "format": "date", "description": "Date when scan was taken" }, "globalTransformationId": { "type": "string", "description": "Optional global transformation ID" }, "scanTransformationMatrix": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, "minItems": 4, "maxItems": 4 }, "metadata": { "type": "object", "description": "Optional scan metadata", "properties": { "floorNumber": { "type": "string", "description": "Floor number for the scan" }, "googleMapsCoordinates": { "type": "string", "description": "Google Maps coordinates string" }, "googleMapsLink": { "type": "string", "description": "Google Maps link" }, "overhangPossibility": { "type": "array", "items": { "type": "string" }, "description": "List of overhang possibilities" }, "requiredKwCapacity": { "type": "string", "description": "Required kW capacity" }, "startingCoordinatesOnFloorplan": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number", "description": "X coordinate on the floorplan" }, "y": { "type": "number", "description": "Y coordinate on the floorplan" } } } } }, "input": { "type": "object", "required": [ "type", "metadata", "gcpData" ], "properties": { "type": { "type": "string", "enum": [ "IMAGES", "POINTCLOUD", "VIDEO" ], "description": "Type of input data" }, "metadata": { "type": "object", "description": "Additional metadata for the input" }, "gcpData": { "type": "array", "items": { "type": "object", "description": "GCP data for the input" } } } }, "outputs": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "SPARSECLOUD", "BINSEG", "FULLSEG", "DTM", "DEM", "ORTHO", "VIRTUALTOUR" ] }, "metadata": { "type": "object" }, "virtualTour": { "type": "object", "properties": { "resolution": { "type": "string" } } } } } } } } } }, "responses": { "201": { "description": "Scan created successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "projectId", "scanDate", "input", "outputs" ], "properties": { "projectId": { "type": "string" }, "description": { "type": "string" }, "scanDate": { "type": "string", "format": "date" }, "globalTransformationId": { "type": "string" }, "scanTransformationMatrix": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, "minItems": 4, "maxItems": 4 }, "input": { "type": "object", "required": [ "type", "metadata", "gcpData" ], "properties": { "type": { "type": "string", "enum": [ "IMAGES", "POINTCLOUD", "VIDEO" ] }, "metadata": { "type": "object" }, "gcpData": { "type": "array" } } }, "outputs": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "SPARSECLOUD", "BINSEG", "FULLSEG", "DTM", "DEM", "ORTHO", "VIRTUALTOUR" ] }, "metadata": { "type": "object" }, "virtualTour": { "type": "object", "properties": { "resolution": { "type": "string" } } } } } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "post_scan" }, "delete": { "summary": "Delete multiple scans", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "scanIDs" ], "properties": { "scanIDs": { "type": "array", "items": { "type": "string" }, "description": "Array of scan IDs to delete" } } } } } }, "responses": { "204": { "description": "Scans deleted successfully" }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "delete_scan" } }, "/scan/{scanId}": { "get": { "summary": "Get scan details", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "description": "ID of the scan to retrieve", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Scan details retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "projectId", "scanDate", "input", "outputs" ], "properties": { "projectId": { "type": "string" }, "description": { "type": "string" }, "scanDate": { "type": "string", "format": "date" }, "globalTransformationId": { "type": "string" }, "scanTransformationMatrix": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, "minItems": 4, "maxItems": 4 }, "input": { "type": "object", "required": [ "type", "metadata", "gcpData" ], "properties": { "type": { "type": "string", "enum": [ "IMAGES", "POINTCLOUD", "VIDEO" ] }, "metadata": { "type": "object" }, "gcpData": { "type": "array" } } }, "outputs": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "SPARSECLOUD", "BINSEG", "FULLSEG", "DTM", "DEM", "ORTHO", "VIRTUALTOUR" ] }, "metadata": { "type": "object" }, "virtualTour": { "type": "object", "properties": { "resolution": { "type": "string" } } } } } } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_scan_scanId" }, "put": { "summary": "Update scan details", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "description": "ID of the scan to update", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "globalTransformationId": { "type": "string", "description": "Global transformation ID" }, "scanTransformationMatrix": { "type": "array", "description": "4x4 transformation matrix", "items": { "type": "array", "items": { "type": "number" } } }, "description": { "type": "string", "description": "Updated scan description" }, "scanDate": { "type": "string", "format": "date", "description": "Updated scan date" } } } } } }, "responses": { "200": { "description": "Scan updated successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "projectId", "scanDate", "input", "outputs" ], "properties": { "projectId": { "type": "string" }, "description": { "type": "string" }, "scanDate": { "type": "string", "format": "date" }, "globalTransformationId": { "type": "string" }, "scanTransformationMatrix": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, "minItems": 4, "maxItems": 4 }, "input": { "type": "object", "required": [ "type", "metadata", "gcpData" ], "properties": { "type": { "type": "string", "enum": [ "IMAGES", "POINTCLOUD", "VIDEO" ] }, "metadata": { "type": "object" }, "gcpData": { "type": "array" } } }, "outputs": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "SPARSECLOUD", "BINSEG", "FULLSEG", "DTM", "DEM", "ORTHO", "VIRTUALTOUR" ] }, "metadata": { "type": "object" }, "virtualTour": { "type": "object", "properties": { "resolution": { "type": "string" } } } } } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "put_scan_scanId" }, "delete": { "summary": "Delete a scan", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "description": "ID of the scan to delete", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Scan deleted successfully" }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "delete_scan_scanId" } }, "/scan/{scanId}/files": { "get": { "summary": "Get scan files", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "description": "ID of the scan", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page number for pagination", "schema": { "type": "integer" } }, { "name": "perPage", "in": "query", "required": false, "description": "Number of items per page", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "required": false, "description": "Search query for filtering files", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Scan files retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer" }, "perPage": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "get_scan_scanId_files" } }, "/scan/{scanId}/triggerProcessing": { "post": { "summary": "Trigger scan processing", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "description": "ID of the scan to process", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "videoMetadata": { "type": "object", "description": "Optional metadata for video processing" } } } } } }, "responses": { "201": { "description": "Processing triggered successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "metadata", "gcpData" ], "properties": { "type": { "type": "string", "enum": [ "IMAGES", "POINTCLOUD", "VIDEO" ], "description": "Type of input data" }, "metadata": { "type": "object", "description": "Additional metadata for the input" }, "gcpData": { "type": "array", "items": { "type": "object", "description": "GCP data for the input" } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "post_scan_scanId_triggerProcessing" } }, "/scan/add-outputs": { "post": { "summary": "Add additional outputs to an existing scan", "tags": [ "Scans" ], "security": [ { "bearerAuthToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "outputs", "scanId" ], "properties": { "scanId": { "type": "string", "description": "ID of the scan to add outputs to" }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CUSTOM", "SPARSECLOUD", "POINTCLOUD", "FULLSEG", "BINSEG", "DTM", "DEM", "ORTHO" ], "description": "Type of output to create" }, "metadata": { "type": "object", "description": "Additional metadata for the output" }, "markAsCompleted": { "type": "boolean", "description": "Whether to mark the output as completed upon creation" } } } }, "metadata": { "type": "object", "description": "Additional metadata to update on the scan input" } } } } } }, "responses": { "201": { "description": "Outputs created successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "metadata", "gcpData" ], "properties": { "type": { "type": "string", "enum": [ "IMAGES", "POINTCLOUD", "VIDEO" ], "description": "Type of input data" }, "metadata": { "type": "object", "description": "Additional metadata for the input" }, "gcpData": { "type": "array", "items": { "type": "object", "description": "GCP data for the input" } } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "post_scan_add_outputs" } }, "/scan/{scanId}/density-image": { "get": { "summary": "Get Density Image", "tags": [ "Scans" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "operationId": "get_scan_scanId_density_image" } }, "/scan/{scanId}/mark-as-uploaded": { "patch": { "summary": "Mark scan files as uploaded", "tags": [ "Scans" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "videoMetadata": { "type": "object", "additionalProperties": { "type": "object", "properties": { "duration": { "type": "number" }, "start": { "type": "number" }, "end": { "type": "number" } } } }, "additionalInputs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "GPX", "STILL_IMAGES", "CUSTOM_ADDITIONAL", "REF_PDF" ] }, "fileNames": { "type": "array", "items": { "type": "string" } } } } }, "alignWith": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "previousScan", "floor", "gpx", "bim" ] }, "scanId": { "type": "string" }, "floorId": { "type": "string" }, "bimId": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Success" } }, "operationId": "patch_scan_scanId_mark_as_uploaded" } }, "/scan/{scanId}/move-to-project/{targetProjectId}": { "put": { "summary": "Move Scan", "tags": [ "Scans" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "targetProjectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "operationId": "put_scan_scanId_move_to_project_targetProjectId" } }, "/scan/{scanId}/reports": { "get": { "summary": "Get Reports by Scan ID", "tags": [ "Scan Report" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "operationId": "get_scan_scanId_reports" }, "post": { "summary": "Request Report", "tags": [ "Scan Report" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reportTypes": { "type": "array", "items": { "type": "string", "enum": [ "VISUAL_DEFECT", "VISUAL_PROGRESS", "DIFFERENCE_FROM_PREVIOUS", "SEGMENTATION", "DEVIATION", "DEVIATION_3D" ] } }, "previousScanId": { "type": "string" } } } } } }, "responses": { "200": { "description": "Success" } }, "operationId": "post_scan_scanId_reports" } }, "/floor/{floorId}": { "patch": { "summary": "Update Floor", "tags": [ "Floor" ], "parameters": [ { "name": "floorId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "transformationMatrix": { "type": "array", "items": { "type": "number" } }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } } } } }, "responses": { "200": { "description": "Success" } }, "operationId": "patch_floor_floorId" }, "delete": { "summary": "Delete Floor", "tags": [ "Floor" ], "parameters": [ { "name": "floorId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "operationId": "delete_floor_floorId" } }, "/floor/{floorId}/update-metadata": { "patch": { "summary": "Update Floor metadata", "tags": [ "Floor" ], "parameters": [ { "name": "floorId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "obj": { "type": "object", "properties": { "fileName": { "type": "string" }, "lengthX": { "type": "number" }, "lengthY": { "type": "number" }, "centerX": { "type": "number" }, "centerY": { "type": "number" } } } } } } } }, "responses": { "200": { "description": "Success" } }, "operationId": "patch_floor_floorId_update_metadata" } }, "/workspaces/{workspaceId}/projects/{projectId}/transfers": { "post": { "tags": [ "Transfers" ], "description": "Create new Transfer", "parameters": [ { "name": "workspaceId", "description": "ID of the Workspace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "description": "ID of the Project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inputType": { "type": "string", "enum": [ "POINTCLOUD", "IMAGES" ] }, "url": { "type": "string" }, "provider": { "type": "string", "enum": [ "NORMAL", "DRIVE", "DROPBOX", "S3", "ONEDRIVE" ] }, "totalSize": { "type": "number" } }, "required": [ "inputType", "url", "totalSize", "provider" ] } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "inputType": { "type": "string", "enum": [ "POINTCLOUD", "IMAGES" ] }, "url": { "type": "string" }, "provider": { "type": "string", "enum": [ "NORMAL", "DRIVE", "DROPBOX", "S3", "ONEDRIVE" ] }, "progress": { "type": "number" }, "totalSize": { "type": "number" }, "status": { "type": "string", "enum": [ "PENDING", "SUCCESSFUL", "FAILED" ] }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "post_workspaces_workspaceId_projects_projectId_transfers", "summary": "Create a project transfer" } }, "/workspaces/{workspaceId}/projects/{projectId}/transfers/{transferId}": { "patch": { "tags": [ "Transfers" ], "description": "Patch a transfer", "parameters": [ { "name": "workspaceId", "description": "ID of the Workspace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "description": "ID of the Project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transferId", "description": "ID of the Transfer", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "SUCCESSFUL", "FAILED" ] }, "progress": { "type": "number" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "inputType": { "type": "string", "enum": [ "POINTCLOUD", "IMAGES" ] }, "url": { "type": "string" }, "provider": { "type": "string", "enum": [ "NORMAL", "DRIVE", "DROPBOX", "S3", "ONEDRIVE" ] }, "progress": { "type": "number" }, "totalSize": { "type": "number" }, "status": { "type": "string", "enum": [ "PENDING", "SUCCESSFUL", "FAILED" ] }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Bad request. Request parameters were invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized. Fail to authenticate the requester.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "403": { "description": "Forbidden. The requester does not have the correct permission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "default": true }, "message": { "type": "string" } } } } } } }, "operationId": "patch_workspaces_workspaceId_projects_projectId_transfers_transferId", "summary": "Update a project transfer" } }, "/virtual-tour/{tourId}/reference-measurements": { "get": { "summary": "Get Reference Measurements", "tags": [ "Virtual-Tour" ], "parameters": [ { "name": "tourId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedBy": { "nullable": true }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true }, "positions": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } }, "distance": { "type": "integer" }, "metadata": { "nullable": true }, "tourId": { "type": "string" } } } } } } } }, "operationId": "get_virtual_tour_tourId_reference_measurements" }, "delete": { "summary": "Delete All Reference Measurements of a Virtual Tour", "tags": [ "Virtual-Tour" ], "parameters": [ { "name": "tourId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "operationId": "delete_virtual_tour_tourId_reference_measurements" } } }, "components": { "securitySchemes": { "bearerAuthToken": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }