fmea-api-mcp-server 1.1.13 → 1.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/data/search-index.oxy +1 -1
  2. package/dist/index.js +1 -1
  3. package/dist/synonyms.js +6 -3
  4. package/dist/utils/ScoreCalculator.js +4 -1
  5. package/endpoints/v1/block-diagrams/core.json +24 -3
  6. package/endpoints/v1/divisions/core.json +61 -3
  7. package/endpoints/v1/failure-modes/core.json +9 -1
  8. package/endpoints/v1/knowledge-base/core.json +77 -2
  9. package/endpoints/v1/projects/recommendations.json +53 -1
  10. package/endpoints/v1/synonyms/core.json +57 -3
  11. package/endpoints/v1/terms/core.json +90 -3
  12. package/endpoints/v1/users/admin.json +59 -1
  13. package/endpoints/v1/users/core.json +51 -1
  14. package/endpoints/v2/block-diagrams/core.json +168 -2
  15. package/endpoints/v2/divisions/core.json +19 -1
  16. package/endpoints/v2/documents/core.json +212 -6
  17. package/endpoints/v2/excel/core.json +22 -0
  18. package/endpoints/v2/failure-modes/core.json +84 -0
  19. package/endpoints/v2/fourm/core.json +1 -1
  20. package/endpoints/v2/projects/core.json +39 -5
  21. package/endpoints/v2/system/core.json +21 -3
  22. package/endpoints/v2/templates/core.json +17 -2
  23. package/endpoints/v2/users/core.json +162 -2
  24. package/endpoints/v2/worksheets/core.json +16 -3
  25. package/endpoints/v2/worksheets/excel.json +62 -2
  26. package/endpoints/v2/worksheets/management.json +15 -2
  27. package/package.json +1 -1
package/endpoints/v2/block-diagrams/core.json CHANGED
@@ -25,7 +25,43 @@
25
25
  "default": {
26
26
  "description": "default response",
27
27
  "content": {
28
- "application/json": {}
28
+ "application/json": {
29
+ "schema": {
30
+ "type": "array",
31
+ "items": {
32
+ "type": "object",
33
+ "properties": {
34
+ "id": {
35
+ "type": "string"
36
+ },
37
+ "type": {
38
+ "type": "string",
39
+ "enum": [
40
+ "FUNCTION",
41
+ "STRUCTURE",
42
+ "FUNCTION_STRUCTURE",
43
+ "STRUCTURE_FUNCTION",
44
+ "PROCESS",
45
+ "SUPER_SYSTEM",
46
+ "FUNCTION_ANALYSIS"
47
+ ]
48
+ },
49
+ "alias": {
50
+ "type": "string"
51
+ },
52
+ "order": {
53
+ "type": "integer"
54
+ },
55
+ "description": {
56
+ "type": "string"
57
+ },
58
+ "numberFormat": {
59
+ "type": "string"
60
+ }
61
+ }
62
+ }
63
+ }
64
+ }
29
65
  }
30
66
  }
31
67
  }
@@ -60,7 +96,55 @@
60
96
  "default": {
61
97
  "description": "default response",
62
98
  "content": {
63
- "application/json": {}
99
+ "application/json": {
100
+ "schema": {
101
+ "type": "array",
102
+ "items": {
103
+ "type": "object",
104
+ "properties": {
105
+ "id": {
106
+ "type": "string"
107
+ },
108
+ "parentId": {
109
+ "type": "string"
110
+ },
111
+ "referencedId": {
112
+ "type": "string"
113
+ },
114
+ "function": {
115
+ "type": "string"
116
+ },
117
+ "item": {
118
+ "type": "string"
119
+ },
120
+ "requirement": {
121
+ "type": "string"
122
+ },
123
+ "type": {
124
+ "type": "string",
125
+ "enum": [
126
+ "SUB_FUNCTION",
127
+ "NEW_CHANGE_ASSEMBLY",
128
+ "NEW_CHANGE_PART",
129
+ "TARGET"
130
+ ]
131
+ },
132
+ "order": {
133
+ "type": "integer"
134
+ },
135
+ "processNumber": {
136
+ "type": "string"
137
+ },
138
+ "processFlowChartName": {
139
+ "type": "string"
140
+ },
141
+ "processFlowChartSymbol": {
142
+ "type": "string"
143
+ }
144
+ }
145
+ }
146
+ }
147
+ }
64
148
  }
65
149
  }
66
150
  }
@@ -332,6 +416,49 @@
332
416
  }
333
417
  }
334
418
  },
419
+ {
420
+ "path": "/api/v2/projects/{projectId}/block-diagrams/{blockDiagramId}/failure-modes/{failureModeId}",
421
+ "method": "DELETE",
422
+ "operationId": "deleteFailureMode_1",
423
+ "summary": "Delete Failure Mode from Block Diagram (v2)",
424
+ "description": "Deletes a predefined failure mode from a specific block diagram within a project. This destructive operation permanently removes the failure mode and any associated FMM diagram structural data from the component. Use this endpoint to clean up incorrect entries, remove obsolete failure definitions, or restructure the block diagram's failure analysis. Since this action is irreversible, it should be called only after user confirmation. It is essential for maintaining accurate and up-to-date Failure Mode and Effects Analysis (FMEA) records.",
425
+ "tags": [],
426
+ "parameters": [
427
+ {
428
+ "name": "projectId",
429
+ "in": "path",
430
+ "required": true,
431
+ "schema": {
432
+ "type": "string"
433
+ }
434
+ },
435
+ {
436
+ "name": "blockDiagramId",
437
+ "in": "path",
438
+ "required": true,
439
+ "schema": {
440
+ "type": "string"
441
+ }
442
+ },
443
+ {
444
+ "name": "failureModeId",
445
+ "in": "path",
446
+ "required": true,
447
+ "schema": {
448
+ "type": "string"
449
+ }
450
+ }
451
+ ],
452
+ "requestBody": null,
453
+ "responses": {
454
+ "default": {
455
+ "description": "default response",
456
+ "content": {
457
+ "*/*": {}
458
+ }
459
+ }
460
+ }
461
+ },
335
462
  {
336
463
  "path": "/api/v2/template/block-diagrams/{blockDiagramType}/sheet-headers",
337
464
  "method": "GET",
@@ -367,6 +494,45 @@
367
494
  }
368
495
  }
369
496
  }
497
+ },
498
+ {
499
+ "path": "/api/v2/projects/{projectId}/block-diagrams/{blockDiagramId}/failure-modes",
500
+ "method": "POST",
501
+ "summary": "Create Failure Modes from Block Diagram",
502
+ "description": "Batch generates and creates multiple failure modes simultaneously, specifically linking them to a defined block diagram and its underlying components. Use this powerful bulk operation to quickly populate an FMEA worksheet, translate block diagram vulnerabilities into formal failure modes, and accelerate risk assessment initialization. (Generate Failure Modes / Batch Create Failures / Link Flaws to Diagram / Bulk Add).",
503
+ "tags": [],
504
+ "operationId": "create_2",
505
+ "parameters": [
506
+ {
507
+ "name": "projectId",
508
+ "in": "path",
509
+ "required": true,
510
+ "schema": {
511
+ "type": "string"
512
+ }
513
+ },
514
+ {
515
+ "name": "blockDiagramId",
516
+ "in": "path",
517
+ "required": true,
518
+ "schema": {
519
+ "type": "string"
520
+ }
521
+ }
522
+ ],
523
+ "requestBody": {
524
+ "content": {
525
+ "application/json": {}
526
+ }
527
+ },
528
+ "responses": {
529
+ "default": {
530
+ "description": "default response",
531
+ "content": {
532
+ "application/json": {}
533
+ }
534
+ }
535
+ }
370
536
  }
371
537
  ]
372
538
  }
package/endpoints/v2/divisions/core.json CHANGED
@@ -25,7 +25,25 @@
25
25
  "default": {
26
26
  "description": "default response",
27
27
  "content": {
28
- "application/json": {}
28
+ "application/json": {
29
+ "schema": {
30
+ "type": "object",
31
+ "properties": {
32
+ "id": {
33
+ "type": "integer"
34
+ },
35
+ "no": {
36
+ "type": "integer"
37
+ },
38
+ "name": {
39
+ "type": "string"
40
+ },
41
+ "code": {
42
+ "type": "string"
43
+ }
44
+ }
45
+ }
46
+ }
29
47
  }
30
48
  }
31
49
  }
package/endpoints/v2/documents/core.json CHANGED
@@ -39,7 +39,47 @@
39
39
  "default": {
40
40
  "description": "default response",
41
41
  "content": {
42
- "application/json": {}
42
+ "application/json": {
43
+ "schema": {
44
+ "type": "array",
45
+ "items": {
46
+ "type": "object",
47
+ "properties": {
48
+ "id": {
49
+ "type": "integer"
50
+ },
51
+ "type": {
52
+ "type": "string",
53
+ "enum": [
54
+ "UPLOAD"
55
+ ]
56
+ },
57
+ "value": {
58
+ "type": "string"
59
+ },
60
+ "path": {
61
+ "type": "string"
62
+ },
63
+ "fileSize": {
64
+ "type": "string"
65
+ },
66
+ "uploadDate": {
67
+ "type": "string",
68
+ "format": "date"
69
+ },
70
+ "category": {
71
+ "type": "string",
72
+ "enum": [
73
+ "SYSTEM_DEFINITION",
74
+ "WORKSHEET",
75
+ "BLOCK_DIAGRAM",
76
+ "FMM_DIAGRAM"
77
+ ]
78
+ }
79
+ }
80
+ }
81
+ }
82
+ }
43
83
  }
44
84
  }
45
85
  }
@@ -88,7 +128,44 @@
88
128
  "default": {
89
129
  "description": "default response",
90
130
  "content": {
91
- "*/*": {}
131
+ "application/json": {
132
+ "schema": {
133
+ "type": "object",
134
+ "properties": {
135
+ "id": {
136
+ "type": "integer"
137
+ },
138
+ "type": {
139
+ "type": "string",
140
+ "enum": [
141
+ "UPLOAD"
142
+ ]
143
+ },
144
+ "value": {
145
+ "type": "string"
146
+ },
147
+ "path": {
148
+ "type": "string"
149
+ },
150
+ "fileSize": {
151
+ "type": "string"
152
+ },
153
+ "uploadDate": {
154
+ "type": "string",
155
+ "format": "date"
156
+ },
157
+ "category": {
158
+ "type": "string",
159
+ "enum": [
160
+ "SYSTEM_DEFINITION",
161
+ "WORKSHEET",
162
+ "BLOCK_DIAGRAM",
163
+ "FMM_DIAGRAM"
164
+ ]
165
+ }
166
+ }
167
+ }
168
+ }
92
169
  }
93
170
  }
94
171
  }
@@ -124,7 +201,44 @@
124
201
  "default": {
125
202
  "description": "default response",
126
203
  "content": {
127
- "application/json": {}
204
+ "application/json": {
205
+ "schema": {
206
+ "type": "object",
207
+ "properties": {
208
+ "id": {
209
+ "type": "integer"
210
+ },
211
+ "type": {
212
+ "type": "string",
213
+ "enum": [
214
+ "UPLOAD"
215
+ ]
216
+ },
217
+ "value": {
218
+ "type": "string"
219
+ },
220
+ "path": {
221
+ "type": "string"
222
+ },
223
+ "fileSize": {
224
+ "type": "string"
225
+ },
226
+ "uploadDate": {
227
+ "type": "string",
228
+ "format": "date"
229
+ },
230
+ "category": {
231
+ "type": "string",
232
+ "enum": [
233
+ "SYSTEM_DEFINITION",
234
+ "WORKSHEET",
235
+ "BLOCK_DIAGRAM",
236
+ "FMM_DIAGRAM"
237
+ ]
238
+ }
239
+ }
240
+ }
241
+ }
128
242
  }
129
243
  }
130
244
  }
@@ -196,7 +310,19 @@
196
310
  "default": {
197
311
  "description": "default response",
198
312
  "content": {
199
- "application/json": {}
313
+ "application/json": {
314
+ "schema": {
315
+ "type": "object",
316
+ "properties": {
317
+ "fileName": {
318
+ "type": "string"
319
+ },
320
+ "downloadUri": {
321
+ "type": "string"
322
+ }
323
+ }
324
+ }
325
+ }
200
326
  }
201
327
  }
202
328
  }
@@ -223,7 +349,47 @@
223
349
  "default": {
224
350
  "description": "default response",
225
351
  "content": {
226
- "application/json": {}
352
+ "application/json": {
353
+ "schema": {
354
+ "type": "array",
355
+ "items": {
356
+ "type": "object",
357
+ "properties": {
358
+ "id": {
359
+ "type": "integer"
360
+ },
361
+ "type": {
362
+ "type": "string",
363
+ "enum": [
364
+ "UPLOAD"
365
+ ]
366
+ },
367
+ "value": {
368
+ "type": "string"
369
+ },
370
+ "path": {
371
+ "type": "string"
372
+ },
373
+ "fileSize": {
374
+ "type": "string"
375
+ },
376
+ "uploadDate": {
377
+ "type": "string",
378
+ "format": "date"
379
+ },
380
+ "category": {
381
+ "type": "string",
382
+ "enum": [
383
+ "SYSTEM_DEFINITION",
384
+ "WORKSHEET",
385
+ "BLOCK_DIAGRAM",
386
+ "FMM_DIAGRAM"
387
+ ]
388
+ }
389
+ }
390
+ }
391
+ }
392
+ }
227
393
  }
228
394
  }
229
395
  }
@@ -272,7 +438,47 @@
272
438
  "default": {
273
439
  "description": "default response",
274
440
  "content": {
275
- "application/json": {}
441
+ "application/json": {
442
+ "schema": {
443
+ "type": "array",
444
+ "items": {
445
+ "type": "object",
446
+ "properties": {
447
+ "id": {
448
+ "type": "integer"
449
+ },
450
+ "type": {
451
+ "type": "string",
452
+ "enum": [
453
+ "UPLOAD"
454
+ ]
455
+ },
456
+ "value": {
457
+ "type": "string"
458
+ },
459
+ "path": {
460
+ "type": "string"
461
+ },
462
+ "fileSize": {
463
+ "type": "string"
464
+ },
465
+ "uploadDate": {
466
+ "type": "string",
467
+ "format": "date"
468
+ },
469
+ "category": {
470
+ "type": "string",
471
+ "enum": [
472
+ "SYSTEM_DEFINITION",
473
+ "WORKSHEET",
474
+ "BLOCK_DIAGRAM",
475
+ "FMM_DIAGRAM"
476
+ ]
477
+ }
478
+ }
479
+ }
480
+ }
481
+ }
276
482
  }
277
483
  }
278
484
  }
package/endpoints/v2/excel/core.json CHANGED
@@ -112,6 +112,28 @@
112
112
  }
113
113
  }
114
114
  }
115
+ },
116
+ {
117
+ "path": "/api/v2/excel/generate",
118
+ "method": "POST",
119
+ "summary": "Generate Excel File",
120
+ "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).",
121
+ "tags": [],
122
+ "operationId": "generate",
123
+ "parameters": [],
124
+ "requestBody": {
125
+ "content": {
126
+ "application/json": {}
127
+ }
128
+ },
129
+ "responses": {
130
+ "default": {
131
+ "description": "default response",
132
+ "content": {
133
+ "application/json": {}
134
+ }
135
+ }
136
+ }
115
137
  }
116
138
  ]
117
139
  }
package/endpoints/v2/failure-modes/core.json CHANGED
@@ -46,6 +46,49 @@
46
46
  }
47
47
  }
48
48
  },
49
+ {
50
+ "path": "/api/v2/projects/{projectId}/block-diagrams/{blockDiagramId}/failure-modes/{failureModeId}",
51
+ "method": "DELETE",
52
+ "operationId": "deleteFailureMode",
53
+ "summary": "Delete Failure Mode",
54
+ "description": "Deletes a predefined failure mode from a specific block diagram within a project. This destructive operation permanently removes the failure mode and any associated FMM diagram structural data from the component. Use this endpoint to clean up incorrect entries, remove obsolete failure definitions, or restructure the block diagram's failure analysis. Since this action is irreversible, it should be called only after user confirmation. It is essential for maintaining accurate and up-to-date Failure Mode and Effects Analysis (FMEA) records.",
55
+ "tags": [],
56
+ "parameters": [
57
+ {
58
+ "name": "projectId",
59
+ "in": "path",
60
+ "required": true,
61
+ "schema": {
62
+ "type": "string"
63
+ }
64
+ },
65
+ {
66
+ "name": "blockDiagramId",
67
+ "in": "path",
68
+ "required": true,
69
+ "schema": {
70
+ "type": "string"
71
+ }
72
+ },
73
+ {
74
+ "name": "failureModeId",
75
+ "in": "path",
76
+ "required": true,
77
+ "schema": {
78
+ "type": "string"
79
+ }
80
+ }
81
+ ],
82
+ "requestBody": null,
83
+ "responses": {
84
+ "default": {
85
+ "description": "default response",
86
+ "content": {
87
+ "*/*": {}
88
+ }
89
+ }
90
+ }
91
+ },
49
92
  {
50
93
  "path": "/api/v2/projects/{projectId}/failure-modes/{failureModeId}/fmm-diagram",
51
94
  "method": "PUT",
@@ -90,6 +133,47 @@
90
133
  }
91
134
  }
92
135
  }
136
+ },
137
+ {
138
+ "path": "/api/v2/projects/{projectId}/failure-modes/{failureModeId}/fmm-diagram",
139
+ "method": "POST",
140
+ "summary": "Create FMM Diagram",
141
+ "description": "Initializes and creates a new Functional Mock-up Interface (FMM) diagram structure for a targeted failure mode within a specific project context. Use this endpoint to begin visual failure mapping, establish a new causal chain diagram, or set up the visual canvas for root cause analysis (RCA). Returns the newly created diagram metadata and ID. Crucial for converting flat failure mode text into interactive visual models. (New FMM / Initialize Diagram / Create Failure Model / Build Causal Tree).",
142
+ "tags": [
143
+ "FMM Diagram"
144
+ ],
145
+ "operationId": "createDiagram",
146
+ "parameters": [
147
+ {
148
+ "name": "projectId",
149
+ "in": "path",
150
+ "required": true,
151
+ "schema": {
152
+ "type": "string"
153
+ }
154
+ },
155
+ {
156
+ "name": "failureModeId",
157
+ "in": "path",
158
+ "required": true,
159
+ "schema": {
160
+ "type": "string"
161
+ }
162
+ }
163
+ ],
164
+ "requestBody": {
165
+ "content": {
166
+ "application/json": {}
167
+ }
168
+ },
169
+ "responses": {
170
+ "default": {
171
+ "description": "default response",
172
+ "content": {
173
+ "application/json": {}
174
+ }
175
+ }
176
+ }
93
177
  }
94
178
  ]
95
179
  }
package/endpoints/v2/fourm/core.json CHANGED
@@ -49,7 +49,7 @@
49
49
  {
50
50
  "path": "/api/v2/fourm",
51
51
  "method": "POST",
52
- "operationId": "create",
52
+ "operationId": "create_3",
53
53
  "summary": "Create 4M analysis item",
54
54
  "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.",
55
55
  "tags": [],
package/endpoints/v2/projects/core.json CHANGED
@@ -24,7 +24,12 @@
24
24
  "default": {
25
25
  "description": "default response",
26
26
  "content": {
27
- "application/json": {}
27
+ "application/json": {
28
+ "schema": {
29
+ "type": "string",
30
+ "description": "(unresolved: ProjectDTO)"
31
+ }
32
+ }
28
33
  }
29
34
  }
30
35
  }
@@ -41,7 +46,15 @@
41
46
  "default": {
42
47
  "description": "default response",
43
48
  "content": {
44
- "application/json": {}
49
+ "application/json": {
50
+ "schema": {
51
+ "type": "array",
52
+ "items": {
53
+ "type": "string",
54
+ "description": "(unresolved: ProjectSummaryDTO)"
55
+ }
56
+ }
57
+ }
45
58
  }
46
59
  }
47
60
  }
@@ -67,7 +80,12 @@
67
80
  "default": {
68
81
  "description": "default response",
69
82
  "content": {
70
- "application/json": {}
83
+ "application/json": {
84
+ "schema": {
85
+ "type": "string",
86
+ "description": "(unresolved: ProjectSummaryDTO)"
87
+ }
88
+ }
71
89
  }
72
90
  }
73
91
  }
@@ -93,7 +111,15 @@
93
111
  "default": {
94
112
  "description": "default response",
95
113
  "content": {
96
- "application/json": {}
114
+ "application/json": {
115
+ "schema": {
116
+ "type": "array",
117
+ "items": {
118
+ "type": "string",
119
+ "description": "(unresolved: ProjectMemberDTO)"
120
+ }
121
+ }
122
+ }
97
123
  }
98
124
  }
99
125
  }
@@ -119,7 +145,15 @@
119
145
  "default": {
120
146
  "description": "default response",
121
147
  "content": {
122
- "application/json": {}
148
+ "application/json": {
149
+ "schema": {
150
+ "type": "array",
151
+ "items": {
152
+ "type": "string",
153
+ "description": "(unresolved: ProjectJoinRequestDTO)"
154
+ }
155
+ }
156
+ }
123
157
  }
124
158
  }
125
159
  }