fmea-api-mcp-server 1.1.46 → 1.1.47

package/endpoints/v2/documents/core.json

@@ -7,13 +7,16 @@
       "path": "/api/v2/projects/{projectId}/documents/categories/{documentCategory}",
       "method": "GET",
       "operationId": "listByCategory",
-      "summary": "List documents by category",
-      "description": "Retrieves all documents belonging to a specific category within a project (Filter / Query by type). Use this endpoint when you need to fetch documents filtered by their document category type, such as input files, output reports, analysis results, or reference materials. The category parameter allows you to narrow down the document list to a specific classification, enabling targeted document retrieval and organization.",
-      "tags": [],
+      "summary": "List documents by category for a project",
+      "description": "Returns documents in the specified category for the given project. Document categories group related files (e.g., FMEA reports, reference materials).",
+      "tags": [
+        "Documents"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID whose documents to list",
           "required": true,
           "schema": {
             "type": "string"
@@ -22,6 +25,7 @@
         {
           "name": "documentCategory",
           "in": "path",
+          "description": "Document category (e.g., REPORT, REFERENCE)",
           "required": true,
           "schema": {
             "type": "string",
@@ -88,13 +92,16 @@
       "path": "/api/v2/projects/{projectId}/documents/categories/{documentCategory}",
       "method": "POST",
       "operationId": "add_1",
-      "summary": "Add document to category",
-      "description": "Creates and registers a new document entry within a specific category for a project (Upload / Create / Attach file). Use this endpoint to add documents such as analysis reports, input data files, or reference materials to the project. The document will be classified under the specified category, enabling organized storage and retrieval. Requires project member role with NORMAL user level permissions.",
-      "tags": [],
+      "summary": "Add a document to a project category",
+      "description": "Adds a new document entry to the specified category within the project. The document file must be uploaded separately via POST /api/v2/files. Requires project membership.",
+      "tags": [
+        "Documents"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID to add the document to",
           "required": true,
           "schema": {
             "type": "string"
@@ -103,6 +110,7 @@
         {
           "name": "documentCategory",
           "in": "path",
+          "description": "Document category to add to (e.g., REPORT, REFERENCE)",
           "required": true,
           "schema": {
             "type": "string",
@@ -192,13 +200,16 @@
       "path": "/api/v2/projects/{projectId}/documents/{documentId}",
       "method": "GET",
       "operationId": "get_8",
-      "summary": "Get document by ID",
-      "description": "Fetches detailed information for a specific document using its unique identifier (Retrieve / Fetch / View document details). Use this endpoint to obtain complete document metadata including name, category, path, creation timestamp, and associated file information. This is essential when you need to display document details, verify document existence, or access specific document properties before performing further operations like download or deletion.",
-      "tags": [],
+      "summary": "Get a project document by ID",
+      "description": "Returns a single project document by its numeric ID. The document must belong to the specified project.",
+      "tags": [
+        "Documents"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that owns the document",
           "required": true,
           "schema": {
             "type": "string"
@@ -207,6 +218,7 @@
         {
           "name": "documentId",
           "in": "path",
+          "description": "Document ID (numeric)",
           "required": true,
           "schema": {
             "type": "integer",
@@ -265,13 +277,16 @@
       "path": "/api/v2/projects/{projectId}/documents/{documentId}",
       "method": "DELETE",
       "operationId": "delete_8",
-      "summary": "Delete document",
-      "description": "Permanently removes a document from the project using its unique identifier (Remove / Erase document). This operation deletes the document record and disassociates it from the project. Use with caution as this action cannot be undone. Requires project member role with NORMAL user level permissions. Ensure you have the correct document ID before initiating deletion to avoid accidental data loss.",
-      "tags": [],
+      "summary": "Delete a project document",
+      "description": "Permanently deletes the specified document from the project. Returns 204 No Content on success. Requires project membership.",
+      "tags": [
+        "Documents"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that owns the document",
           "required": true,
           "schema": {
             "type": "string"
@@ -280,6 +295,7 @@
         {
           "name": "documentId",
           "in": "path",
+          "description": "Document ID to delete (numeric)",
           "required": true,
           "schema": {
             "type": "integer",
@@ -301,13 +317,16 @@
       "path": "/api/v2/projects/{projectId}/documents/{documentId}/download",
       "method": "GET",
       "operationId": "getDownloadLink_2",
-      "summary": "Get document download link",
-      "description": "Generates a secure download URL for accessing the actual file associated with a document (Download file / Get file URL). Use this endpoint to obtain a temporary, authenticated link that allows users to download the document file. The link includes necessary security tokens to ensure only authorized users can access the file. This is the standard method for retrieving document files after you have identified the document ID through listing or search operations.",
-      "tags": [],
+      "summary": "Get download link for a project document",
+      "description": "Generates and returns a download link (FileDownloadResponseDTO) for the specified document. Use GET /api/v1/files/{uuid} with the returned URI to download the actual file.",
+      "tags": [
+        "Documents"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that owns the document",
           "required": true,
           "schema": {
             "type": "string"
@@ -316,6 +335,7 @@
         {
           "name": "documentId",
           "in": "path",
+          "description": "Document ID to download (numeric)",
           "required": true,
           "schema": {
             "type": "integer",
@@ -349,13 +369,16 @@
       "path": "/api/v2/projects/{projectId}/documents",
       "method": "GET",
       "operationId": "list_14",
-      "summary": "List all Documents",
-      "description": "Retrieves a comprehensive list of all documents associated with a specific project (Get all files / Fetch project documents / Query document library). Use this endpoint when you need to view, browse, or display the complete collection of documents within a project, including all categories and types. The response includes document metadata such as names, categories, paths, and timestamps, enabling users to navigate and manage the project document repository effectively.",
-      "tags": [],
+      "summary": "List all documents for a project",
+      "description": "Returns all documents associated with the specified project, across all categories.",
+      "tags": [
+        "Documents"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID whose documents to list",
           "required": true,
           "schema": {
             "type": "string"
@@ -416,13 +439,16 @@
       "path": "/api/v2/projects/{projectId}/documents/categories/{documentCategory}/path/{documentPath}",
       "method": "GET",
       "operationId": "listByCategoryAndPath",
-      "summary": "List documents by category and path",
-      "description": "Fetches documents matching both a specific category and file path within a project (Filter by type and location / Query documents in folder). Use this endpoint for precise document filtering when you need to retrieve documents from a specific directory or subfolder within a category. The path parameter enables hierarchical navigation, allowing you to access documents organized in nested folder structures. This is particularly useful for browsing documents within specific subdirectories or locations.",
-      "tags": [],
+      "summary": "List documents by category and path for a project",
+      "description": "Returns documents that match both the specified category and virtual path prefix. Supports hierarchical document organization within a category.",
+      "tags": [
+        "Documents"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID whose documents to list",
           "required": true,
           "schema": {
             "type": "string"
@@ -431,6 +457,7 @@
         {
           "name": "documentCategory",
           "in": "path",
+          "description": "Document category (e.g., REPORT, REFERENCE)",
           "required": true,
           "schema": {
             "type": "string",
@@ -445,6 +472,7 @@
         {
           "name": "documentPath",
           "in": "path",
+          "description": "Virtual document path prefix for filtering",
           "required": true,
           "schema": {
             "type": "string"

package/endpoints/v2/excel/core.json

@@ -6,10 +6,10 @@
     {
       "path": "/api/v2/excel/{uuid}",
       "method": "GET",
-      "summary": "Parse all sheets in Excel file",
-      "description": "Extracts and returns ALL worksheets from an uploaded Excel file (.xlsx, .xls). Use this endpoint when you need complete workbook data including multiple sheets. The endpoint parses every tab/worksheet in the Excel file and returns them as a structured list with sheet metadata, row data, and cell values. This is ideal for bulk data extraction, complete workbook analysis, or when the sheet structure is unknown beforehand. Returns a list of POISheet objects containing sheet names, indices, and grid data. Requires valid file UUID from prior upload.",
+      "summary": "Parse all sheets from an uploaded Excel file",
+      "description": "Parses all sheets from a previously uploaded Excel file and returns them as a list of POISheet objects. Requires a prior file upload via POST /api/v2/files. The uuid is the file identifier returned by the upload endpoint. startRowNumber specifies which row to begin parsing (1-based). reindexFromZero resets row indices to start from 0.",
       "tags": [
-        "excel"
+        "Excel"
       ],
       "operationId": "parseAll",
       "x-dependency-warning": "REQUIRES PRIOR FILE UPLOAD via [POST /api/v2/files]. The {uuid} parameter is the file ID returned by the upload endpoint.",
@@ -17,6 +17,7 @@
         {
           "name": "uuid",
           "in": "path",
+          "description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
           "required": true,
           "schema": {
             "type": "string"
@@ -25,6 +26,7 @@
         {
           "name": "startRowNumber",
           "in": "query",
+          "description": "Row number to start parsing from (1-based, optional)",
           "schema": {
             "type": "integer",
             "format": "int32"
@@ -33,6 +35,7 @@
         {
           "name": "reindexFromZero",
           "in": "query",
+          "description": "Whether to reindex row numbers to start from 0 (default: true)",
           "schema": {
             "type": "boolean",
             "default": true
@@ -58,10 +61,10 @@
     {
       "path": "/api/v2/excel/{uuid}/sheets/{sheetIndex}",
       "method": "GET",
-      "summary": "Parse specific sheet in Excel file",
-      "description": "Extracts and returns a SINGLE worksheet from an uploaded Excel file by its zero-based index. Use this endpoint for targeted data retrieval when you know which specific tab/worksheet you need. More efficient than parsing all sheets when working with large workbooks or when only specific sheet data is required. The endpoint returns a POISheet object containing the sheet name, index, and complete grid data with cell values. Ideal for incremental processing, specific tab extraction, or reducing payload size. Sheet index starts at 0 (first sheet). Requires valid file UUID from prior upload.",
+      "summary": "Parse a specific sheet from an uploaded Excel file",
+      "description": "Parses a single sheet from a previously uploaded Excel file by its index. Requires a prior file upload via POST /api/v2/files. The uuid is the file identifier returned by the upload endpoint. startRowNumber specifies which row to begin parsing (1-based). reindexFromZero resets row indices to start from 0.",
       "tags": [
-        "excel"
+        "Excel"
       ],
       "operationId": "parseSheet",
       "x-dependency-warning": "REQUIRES PRIOR FILE UPLOAD via [POST /api/v2/files]. The {uuid} parameter is the file ID returned by the upload endpoint.",
@@ -69,6 +72,7 @@
         {
           "name": "uuid",
           "in": "path",
+          "description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
           "required": true,
           "schema": {
             "type": "string"
@@ -77,6 +81,7 @@
         {
           "name": "sheetIndex",
           "in": "path",
+          "description": "Zero-based index of the sheet to parse",
           "required": true,
           "schema": {
             "type": "integer",
@@ -86,6 +91,7 @@
         {
           "name": "startRowNumber",
           "in": "query",
+          "description": "Row number to start parsing from (1-based, optional)",
           "schema": {
             "type": "integer",
             "format": "int32"
@@ -94,6 +100,7 @@
         {
           "name": "reindexFromZero",
           "in": "query",
+          "description": "Whether to reindex row numbers to start from 0 (default: true)",
           "schema": {
             "type": "boolean",
             "default": true
@@ -116,9 +123,11 @@
     {
       "path": "/api/v2/excel/generate",
       "method": "POST",
-      "summary": "Generate Excel File",
-      "description": "Generates a downloadable Excel (.xlsx) file programmatically based on user-provided column definitions and grid data payloads. Use this endpoint to dynamically construct custom spreadsheet reports, export tabular analysis results, or create structured Excel files from raw JSON arrays. Ideal for custom FMEA reporting, bulk data compilation, and on-the-fly spreadsheet generation. (Create Excel / Export to XLSX / Build Spreadsheet / Generate Report).",
-      "tags": [],
+      "summary": "Generate an Excel file from spreadsheet data",
+      "description": "Converts myspreadsheet worksheet data to an Excel (.xlsx) file. Returns a download URI (FileDownloadResponseDTO) for the generated file. Download the file using the returned URI via GET /api/v1/files/{uuid}.",
+      "tags": [
+        "Excel"
+      ],
       "operationId": "generate",
       "parameters": [],
       "requestBody": {

package/endpoints/v2/failure-modes/core.json

@@ -210,11 +210,11 @@
                 "fmmBlockDiagramType": {
                   "type": "string",
                   "enum": [
-                    "Function",
-                    "Structure",
-                    "FunctionStructure",
-                    "StructureFunction",
-                    "Process"
+                    "FMM_FUNCTION",
+                    "FMM_STRUCTURE",
+                    "FMM_FUNCTION_STRUCTURE",
+                    "FMM_STRUCTURE_FUNCTION",
+                    "FMM_PROCESS"
                   ]
                 },
                 "fmeaType": {

package/endpoints/v2/files/core.json

@@ -7,9 +7,11 @@
       "path": "/api/v2/files",
       "method": "POST",
       "operationId": "upload",
-      "summary": "Upload files",
-      "description": "Initiates file upload by accepting one or more files via multipart/form-data and storing them in a temporary system folder. Returns a list of upload information objects, each containing a unique UUID identifier, original filename, and file size. The returned UUID serves as a temporary file reference that must be used in subsequent processing endpoints (e.g., Excel import, document attachment, data analysis workflows). This is the mandatory first step for any operation requiring file input. Supports batch upload of multiple files in a single request. Alternative terms: file transmission, document submission, attachment upload, bulk file transfer.",
-      "tags": [],
+      "summary": "Upload one or more files",
+      "description": "Accepts a multipart/form-data request with one or more files in the 'files' field. Stores each file and returns a list of upload results including the assigned UUID per file. The UUID is used as a reference in subsequent import operations (e.g., POST /api/v2/projects/{projectId}/worksheet-excel/{uuid}).",
+      "tags": [
+        "Files"
+      ],
       "parameters": [],
       "requestBody": {
         "content": {

package/endpoints/v2/fourm/core.json

@@ -7,13 +7,16 @@
       "path": "/api/v2/fourm",
       "method": "GET",
       "operationId": "list_8",
-      "summary": "List 4M analysis items",
-      "description": "Retrieves all 4M (Man, Machine, Material, Environment) analysis items with optional filtering. Supports querying by project ID (projectId) and single or double tags (tag, secondTag) for targeted searches. Use this endpoint to browse, filter, or search for existing 4M analysis records within a project context. Returns a comprehensive list of analysis entries that can be further processed or displayed.",
-      "tags": [],
+      "summary": "List 4M records",
+      "description": "Returns 4M cause records for a given project. Optionally filtered by function node ID (tag) and a secondary node ID (secondTag). Returns all records when no filter is specified.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "query",
+          "description": "Project ID to filter records",
           "schema": {
             "type": "string"
           }
@@ -21,6 +24,7 @@
         {
           "name": "tag",
           "in": "query",
+          "description": "Function node ID filter (tag)",
           "schema": {
             "type": "string"
           }
@@ -28,6 +32,7 @@
         {
           "name": "secondTag",
           "in": "query",
+          "description": "Secondary node ID filter (secondTag)",
           "schema": {
             "type": "string"
           }
@@ -50,19 +55,19 @@
                     "projectId": {
                       "type": "string"
                     },
-                    "tag": {
+                    "functionNodeId": {
                       "type": "string"
                     },
-                    "secondTag": {
+                    "secondNodeId": {
                       "type": "string"
                     },
                     "category": {
                       "type": "string",
                       "enum": [
-                        "Man",
-                        "Machine",
-                        "Material",
-                        "Environment"
+                        "MAN",
+                        "MACHINE",
+                        "MATERIAL",
+                        "ENVIRONMENT"
                       ]
                     },
                     "workElement": {
@@ -83,9 +88,11 @@
       "path": "/api/v2/fourm",
       "method": "POST",
       "operationId": "create_4",
-      "summary": "Create 4M analysis item",
-      "description": "Creates a new 4M (Man, Machine, Material, Environment) analysis item in the system. Accepts analysis data including categorization by the four M dimensions (Man/Personnel, Machine/Equipment, Material/Resources, Environment/Conditions). Use this endpoint to initiate a new 4M analysis, register factors for quality or risk assessment, or document production variables. Returns the complete created object with system-generated ID.",
-      "tags": [],
+      "summary": "Create a 4M record",
+      "description": "Creates a new 4M cause record with the provided fields. Returns the created record as a FourMDTO.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [],
       "requestBody": {
         "content": {
@@ -96,19 +103,19 @@
                 "projectId": {
                   "type": "string"
                 },
-                "tag": {
+                "functionNodeId": {
                   "type": "string"
                 },
-                "secondTag": {
+                "secondNodeId": {
                   "type": "string"
                 },
                 "category": {
                   "type": "string",
                   "enum": [
-                    "Man",
-                    "Machine",
-                    "Material",
-                    "Environment"
+                    "MAN",
+                    "MACHINE",
+                    "MATERIAL",
+                    "ENVIRONMENT"
                   ]
                 },
                 "workElement": {
@@ -136,19 +143,19 @@
                   "projectId": {
                     "type": "string"
                   },
-                  "tag": {
+                  "functionNodeId": {
                     "type": "string"
                   },
-                  "secondTag": {
+                  "secondNodeId": {
                     "type": "string"
                   },
                   "category": {
                     "type": "string",
                     "enum": [
-                      "Man",
-                      "Machine",
-                      "Material",
-                      "Environment"
+                      "MAN",
+                      "MACHINE",
+                      "MATERIAL",
+                      "ENVIRONMENT"
                     ]
                   },
                   "workElement": {
@@ -168,13 +175,16 @@
       "path": "/api/v2/fourm/{id}",
       "method": "GET",
       "operationId": "get_2",
-      "summary": "Get 4M analysis item by ID",
-      "description": "Retrieves a specific 4M analysis item by its unique identifier (id). Use this endpoint to fetch full details of an existing analysis record for viewing, editing preparation, or detailed examination. Returns complete object including all four M dimensions (Man, Machine, Material, Environment) and associated metadata. Ideal for drill-down operations, detailed inspection, or populating edit forms.",
-      "tags": [],
+      "summary": "Get a 4M record by ID",
+      "description": "Returns a single 4M cause record by its numeric ID. Throws 404 if the record does not exist.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "4M record ID",
           "required": true,
           "schema": {
             "type": "integer",
@@ -197,19 +207,19 @@
                   "projectId": {
                     "type": "string"
                   },
-                  "tag": {
+                  "functionNodeId": {
                     "type": "string"
                   },
-                  "secondTag": {
+                  "secondNodeId": {
                     "type": "string"
                   },
                   "category": {
                     "type": "string",
                     "enum": [
-                      "Man",
-                      "Machine",
-                      "Material",
-                      "Environment"
+                      "MAN",
+                      "MACHINE",
+                      "MATERIAL",
+                      "ENVIRONMENT"
                     ]
                   },
                   "workElement": {
@@ -229,13 +239,16 @@
       "path": "/api/v2/fourm/{id}",
       "method": "PUT",
       "operationId": "update_3",
-      "summary": "Update 4M analysis item",
-      "description": "Modifies an existing 4M analysis item identified by its ID. Accepts partial or complete updates to the analysis data including changes to categorization, descriptions, or any of the four M dimensions (Man, Machine, Material, Environment). Use this endpoint to correct, enhance, or evolve analysis records over time. Returns the updated object reflecting all changes applied.",
-      "tags": [],
+      "summary": "Update a 4M record",
+      "description": "Updates an existing 4M cause record by its numeric ID. Returns the updated record as a FourMDTO.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "4M record ID to update",
           "required": true,
           "schema": {
             "type": "integer",
@@ -252,10 +265,10 @@
                 "category": {
                   "type": "string",
                   "enum": [
-                    "Man",
-                    "Machine",
-                    "Material",
-                    "Environment"
+                    "MAN",
+                    "MACHINE",
+                    "MATERIAL",
+                    "ENVIRONMENT"
                   ]
                 },
                 "workElement": {
@@ -283,19 +296,19 @@
                   "projectId": {
                     "type": "string"
                   },
-                  "tag": {
+                  "functionNodeId": {
                     "type": "string"
                   },
-                  "secondTag": {
+                  "secondNodeId": {
                     "type": "string"
                   },
                   "category": {
                     "type": "string",
                     "enum": [
-                      "Man",
-                      "Machine",
-                      "Material",
-                      "Environment"
+                      "MAN",
+                      "MACHINE",
+                      "MATERIAL",
+                      "ENVIRONMENT"
                     ]
                   },
                   "workElement": {
@@ -315,13 +328,16 @@
       "path": "/api/v2/fourm/{id}",
       "method": "DELETE",
       "operationId": "delete_3",
-      "summary": "Delete 4M analysis item",
-      "description": "Permanently removes a 4M analysis item from the system using its unique identifier. This operation is irreversible and will eliminate all associated data including the four M dimension classifications (Man, Machine, Material, Environment). Use with caution for removing obsolete or incorrect analysis records. Returns no content upon successful deletion (204 status).",
-      "tags": [],
+      "summary": "Delete a 4M record",
+      "description": "Deletes a 4M cause record by its numeric ID. Returns HTTP 204 No Content on success.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "4M record ID to delete",
           "required": true,
           "schema": {
             "type": "integer",

package/endpoints/v2/high-items/core.json

@@ -16,6 +16,7 @@
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID whose high items to update",
           "required": true,
           "schema": {
             "type": "string"