fmea-api-mcp-server 1.1.46 → 1.1.47
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.
- package/data/endpoint-lookup.json +1 -1
- package/data/search-index.oxy +1 -1
- package/dist/index.js +1 -1
- package/dist/synonyms.js +3 -2
- package/endpoints/v2/api-keys/core.json +80 -32
- package/endpoints/v2/block-diagrams/core.json +6 -3
- package/endpoints/v2/condition-library/core.json +65 -2
- package/endpoints/v2/condition-library-excel/core.json +1 -1
- package/endpoints/v2/divisions/core.json +0 -9
- package/endpoints/v2/documents/core.json +49 -21
- package/endpoints/v2/excel/core.json +18 -9
- package/endpoints/v2/failure-modes/core.json +5 -5
- package/endpoints/v2/files/core.json +5 -3
- package/endpoints/v2/fourm/core.json +65 -49
- package/endpoints/v2/high-items/core.json +1 -0
- package/endpoints/v2/projects/core.json +13 -18
- package/endpoints/v2/search/core.json +6 -9
- package/endpoints/v2/system/core.json +17 -9
- package/endpoints/v2/templates/core.json +15 -5
- package/endpoints/v2/tree-search/core.json +4 -4
- package/endpoints/v2/users/core.json +0 -9
- package/endpoints/v2/worksheet-templates/core.json +7 -2
- package/endpoints/v2/worksheets/core.json +33 -15
- package/endpoints/v2/worksheets/excel.json +35 -15
- package/endpoints/v2/worksheets/management.json +28 -10
- package/endpoints/v2/worksheets/templates.json +4 -1
- package/package.json +1 -1
|
@@ -220,7 +220,7 @@
|
|
|
220
220
|
"method": "GET",
|
|
221
221
|
"operationId": "get_3",
|
|
222
222
|
"summary": "Get project details",
|
|
223
|
-
"description": "
|
|
223
|
+
"description": "Returns the full project details for the given project ID. Throws 404 if the project does not exist.",
|
|
224
224
|
"tags": [
|
|
225
225
|
"Project"
|
|
226
226
|
],
|
|
@@ -579,7 +579,7 @@
|
|
|
579
579
|
"method": "GET",
|
|
580
580
|
"operationId": "getSummary",
|
|
581
581
|
"summary": "Get project summary",
|
|
582
|
-
"description": "
|
|
582
|
+
"description": "Returns a lightweight summary of a project including key metrics. Throws 404 if the project does not exist.",
|
|
583
583
|
"tags": [
|
|
584
584
|
"Project"
|
|
585
585
|
],
|
|
@@ -705,15 +705,6 @@
|
|
|
705
705
|
"schema": {
|
|
706
706
|
"type": "string"
|
|
707
707
|
}
|
|
708
|
-
},
|
|
709
|
-
{
|
|
710
|
-
"name": "useSynonym",
|
|
711
|
-
"in": "query",
|
|
712
|
-
"description": "Whether to expand q with synonym dictionary terms (default: true)",
|
|
713
|
-
"schema": {
|
|
714
|
-
"type": "boolean",
|
|
715
|
-
"default": true
|
|
716
|
-
}
|
|
717
708
|
}
|
|
718
709
|
],
|
|
719
710
|
"responses": {
|
|
@@ -791,7 +782,7 @@
|
|
|
791
782
|
"method": "GET",
|
|
792
783
|
"operationId": "getJoinRequestsByProjectId",
|
|
793
784
|
"summary": "List project join requests",
|
|
794
|
-
"description": "
|
|
785
|
+
"description": "Returns all pending and processed join requests for a project. Requires at least MEMBER role in the project.",
|
|
795
786
|
"tags": [
|
|
796
787
|
"Project"
|
|
797
788
|
],
|
|
@@ -952,7 +943,7 @@
|
|
|
952
943
|
"method": "POST",
|
|
953
944
|
"operationId": "createJoinRequest",
|
|
954
945
|
"summary": "Create a project join request",
|
|
955
|
-
"description": "
|
|
946
|
+
"description": "Creates a join request for the authenticated user to join the specified project. Requires the user to not already be a member (NONE role). Returns the created request ID and a Location header.",
|
|
956
947
|
"tags": [
|
|
957
948
|
"Project"
|
|
958
949
|
],
|
|
@@ -995,7 +986,7 @@
|
|
|
995
986
|
"method": "PUT",
|
|
996
987
|
"operationId": "updateJoinRequests",
|
|
997
988
|
"summary": "Approve or reject project join requests in batch",
|
|
998
|
-
"description": "
|
|
989
|
+
"description": "Processes multiple join requests in a single call by approving or rejecting them. Requires at least MEMBER role in the project.",
|
|
999
990
|
"tags": [
|
|
1000
991
|
"Project"
|
|
1001
992
|
],
|
|
@@ -1052,7 +1043,7 @@
|
|
|
1052
1043
|
"method": "PUT",
|
|
1053
1044
|
"operationId": "updateJoinRequest",
|
|
1054
1045
|
"summary": "Approve or reject a project join request",
|
|
1055
|
-
"description": "
|
|
1046
|
+
"description": "Processes a single join request by approving or rejecting it. Requires at least MEMBER role in the project.",
|
|
1056
1047
|
"tags": [
|
|
1057
1048
|
"Project"
|
|
1058
1049
|
],
|
|
@@ -1116,6 +1107,7 @@
|
|
|
1116
1107
|
{
|
|
1117
1108
|
"name": "projectId",
|
|
1118
1109
|
"in": "path",
|
|
1110
|
+
"description": "Project ID whose high items to list",
|
|
1119
1111
|
"required": true,
|
|
1120
1112
|
"schema": {
|
|
1121
1113
|
"type": "string"
|
|
@@ -1124,7 +1116,7 @@
|
|
|
1124
1116
|
{
|
|
1125
1117
|
"name": "q",
|
|
1126
1118
|
"in": "query",
|
|
1127
|
-
"description": "
|
|
1119
|
+
"description": "Keyword filter for high-item titles (optional)",
|
|
1128
1120
|
"schema": {
|
|
1129
1121
|
"type": "string"
|
|
1130
1122
|
}
|
|
@@ -1174,7 +1166,7 @@
|
|
|
1174
1166
|
"method": "PATCH",
|
|
1175
1167
|
"operationId": "patchProject",
|
|
1176
1168
|
"summary": "Partially update project details",
|
|
1177
|
-
"description": "",
|
|
1169
|
+
"description": "Applies partial updates to a project using the PATCH method. Only provided fields are updated; omitted fields remain unchanged. Returns the updated project details.",
|
|
1178
1170
|
"tags": [
|
|
1179
1171
|
"Project"
|
|
1180
1172
|
],
|
|
@@ -1372,11 +1364,14 @@
|
|
|
1372
1364
|
"operationId": "refreshWorksheetSnapshot",
|
|
1373
1365
|
"summary": "Refresh worksheet dashboard snapshots",
|
|
1374
1366
|
"description": "Manually refreshes worksheet dashboard snapshots. If divisionId is specified, only that division is refreshed; otherwise all cached divisions are refreshed sequentially. Divisions already being refreshed are skipped. Executes synchronously and returns the result after completion.",
|
|
1375
|
-
"tags": [
|
|
1367
|
+
"tags": [
|
|
1368
|
+
"Admin - Dashboard"
|
|
1369
|
+
],
|
|
1376
1370
|
"parameters": [
|
|
1377
1371
|
{
|
|
1378
1372
|
"name": "divisionId",
|
|
1379
1373
|
"in": "query",
|
|
1374
|
+
"description": "Division ID to refresh; if omitted, all cached divisions are refreshed",
|
|
1380
1375
|
"schema": {
|
|
1381
1376
|
"type": "integer",
|
|
1382
1377
|
"format": "int32"
|
|
@@ -136,11 +136,11 @@
|
|
|
136
136
|
"blockType": {
|
|
137
137
|
"type": "string",
|
|
138
138
|
"enum": [
|
|
139
|
-
"
|
|
140
|
-
"
|
|
141
|
-
"
|
|
142
|
-
"
|
|
143
|
-
"
|
|
139
|
+
"FMM_FUNCTION",
|
|
140
|
+
"FMM_STRUCTURE",
|
|
141
|
+
"FMM_FUNCTION_STRUCTURE",
|
|
142
|
+
"FMM_STRUCTURE_FUNCTION",
|
|
143
|
+
"FMM_PROCESS"
|
|
144
144
|
]
|
|
145
145
|
},
|
|
146
146
|
"blockNodeId": {
|
|
@@ -152,10 +152,7 @@
|
|
|
152
152
|
"fmmDiagramType": {
|
|
153
153
|
"type": "string",
|
|
154
154
|
"enum": [
|
|
155
|
-
"UNUSED"
|
|
156
|
-
"NOT_SELECTED",
|
|
157
|
-
"TYPE_A",
|
|
158
|
-
"TYPE_C"
|
|
155
|
+
"UNUSED"
|
|
159
156
|
]
|
|
160
157
|
},
|
|
161
158
|
"complete": {
|
|
@@ -6,14 +6,17 @@
|
|
|
6
6
|
{
|
|
7
7
|
"path": "/api/v2/open/metrics/{apType}/constants",
|
|
8
8
|
"method": "GET",
|
|
9
|
-
"summary": "Get metric constants",
|
|
10
|
-
"description": "
|
|
11
|
-
"tags": [
|
|
9
|
+
"summary": "Get metric constants for an AP type",
|
|
10
|
+
"description": "Returns severity, occurrence, and detection metric constants for the given action priority type (AIAG or MSR). Used to populate evaluation criteria dropdowns and compute RPN values. This endpoint is open and does not require authentication.",
|
|
11
|
+
"tags": [
|
|
12
|
+
"Metrics"
|
|
13
|
+
],
|
|
12
14
|
"operationId": "getMetricConstants",
|
|
13
15
|
"parameters": [
|
|
14
16
|
{
|
|
15
17
|
"name": "apType",
|
|
16
18
|
"in": "path",
|
|
19
|
+
"description": "Action priority type: aiag or msr (case-insensitive)",
|
|
17
20
|
"required": true,
|
|
18
21
|
"schema": {
|
|
19
22
|
"type": "string"
|
|
@@ -33,14 +36,17 @@
|
|
|
33
36
|
{
|
|
34
37
|
"path": "/api/v2/system/context-version",
|
|
35
38
|
"method": "GET",
|
|
36
|
-
"summary": "Get
|
|
37
|
-
"description": "
|
|
38
|
-
"tags": [
|
|
39
|
+
"summary": "Get version info for a deployed web application context",
|
|
40
|
+
"description": "Reads the VERSION file from the given Tomcat webapp sub-path and returns the version string and build date. Returns 400 if contextPath is missing, 404 if the VERSION file does not exist or is unreadable.",
|
|
41
|
+
"tags": [
|
|
42
|
+
"System"
|
|
43
|
+
],
|
|
39
44
|
"operationId": "checkContext",
|
|
40
45
|
"parameters": [
|
|
41
46
|
{
|
|
42
47
|
"name": "contextPath",
|
|
43
48
|
"in": "query",
|
|
49
|
+
"description": "Tomcat webapp sub-path to read the VERSION file from (e.g. 'fmea-frontend'). Leading slashes are stripped.",
|
|
44
50
|
"schema": {
|
|
45
51
|
"type": "string"
|
|
46
52
|
}
|
|
@@ -59,9 +65,11 @@
|
|
|
59
65
|
{
|
|
60
66
|
"path": "/api/v2/system/health",
|
|
61
67
|
"method": "GET",
|
|
62
|
-
"summary": "
|
|
63
|
-
"description": "
|
|
64
|
-
"tags": [
|
|
68
|
+
"summary": "Health check",
|
|
69
|
+
"description": "Returns the current server status and UTC timestamp. Always returns HTTP 200 with status='UP' when the application is running. No authentication required.",
|
|
70
|
+
"tags": [
|
|
71
|
+
"System"
|
|
72
|
+
],
|
|
65
73
|
"operationId": "health",
|
|
66
74
|
"parameters": [],
|
|
67
75
|
"requestBody": null,
|
|
@@ -9,7 +9,9 @@
|
|
|
9
9
|
"operationId": "getAll_1",
|
|
10
10
|
"summary": "Get all action statuses",
|
|
11
11
|
"description": "Returns all action status items. Used for populating action status dropdowns in worksheets.",
|
|
12
|
-
"tags": [
|
|
12
|
+
"tags": [
|
|
13
|
+
"Template"
|
|
14
|
+
],
|
|
13
15
|
"parameters": [],
|
|
14
16
|
"responses": {
|
|
15
17
|
"default": {
|
|
@@ -41,7 +43,9 @@
|
|
|
41
43
|
"operationId": "create_7",
|
|
42
44
|
"summary": "Create action status",
|
|
43
45
|
"description": "Creates a new action status. Returns 201 with Location header. Requires ADMIN role. Throws 409 if title already exists.",
|
|
44
|
-
"tags": [
|
|
46
|
+
"tags": [
|
|
47
|
+
"Template"
|
|
48
|
+
],
|
|
45
49
|
"parameters": [],
|
|
46
50
|
"requestBody": {
|
|
47
51
|
"content": {
|
|
@@ -77,7 +81,9 @@
|
|
|
77
81
|
"operationId": "getById_1",
|
|
78
82
|
"summary": "Get action status by ID",
|
|
79
83
|
"description": "Returns a single action status by ID. Returns 404 if not found.",
|
|
80
|
-
"tags": [
|
|
84
|
+
"tags": [
|
|
85
|
+
"Template"
|
|
86
|
+
],
|
|
81
87
|
"parameters": [
|
|
82
88
|
{
|
|
83
89
|
"name": "id",
|
|
@@ -116,7 +122,9 @@
|
|
|
116
122
|
"operationId": "update_6",
|
|
117
123
|
"summary": "Update action status",
|
|
118
124
|
"description": "Updates an existing action status title. Returns updated DTO. Requires ADMIN role. Throws 404 if not found, 409 if title conflicts.",
|
|
119
|
-
"tags": [
|
|
125
|
+
"tags": [
|
|
126
|
+
"Template"
|
|
127
|
+
],
|
|
120
128
|
"parameters": [
|
|
121
129
|
{
|
|
122
130
|
"name": "id",
|
|
@@ -162,7 +170,9 @@
|
|
|
162
170
|
"operationId": "delete_6",
|
|
163
171
|
"summary": "Delete action status",
|
|
164
172
|
"description": "Deletes an action status by ID. Returns 204 No Content. Requires ADMIN role. Throws 404 if not found.",
|
|
165
|
-
"tags": [
|
|
173
|
+
"tags": [
|
|
174
|
+
"Template"
|
|
175
|
+
],
|
|
166
176
|
"parameters": [
|
|
167
177
|
{
|
|
168
178
|
"name": "id",
|
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
"queryMode": {
|
|
33
33
|
"type": "string",
|
|
34
34
|
"enum": [
|
|
35
|
-
"
|
|
36
|
-
"
|
|
37
|
-
"
|
|
35
|
+
"REFERENCE_NODE",
|
|
36
|
+
"ANCHOR_PATTERN",
|
|
37
|
+
"CONTEXT_COMPLETION"
|
|
38
38
|
]
|
|
39
39
|
},
|
|
40
40
|
"query": {
|
|
@@ -270,7 +270,7 @@
|
|
|
270
270
|
"method": "POST",
|
|
271
271
|
"operationId": "rebuild",
|
|
272
272
|
"summary": "Rebuild tree search index",
|
|
273
|
-
"description": "Triggers an asynchronous full rebuild
|
|
273
|
+
"description": "Triggers an asynchronous full rebuild of the Lucene tree search index for the specified domain. Requires ADMIN privileges. Returns 202 if rebuild started, 409 if already in progress.",
|
|
274
274
|
"tags": [
|
|
275
275
|
"Tree Search"
|
|
276
276
|
],
|
|
@@ -21,15 +21,6 @@
|
|
|
21
21
|
"type": "string"
|
|
22
22
|
}
|
|
23
23
|
},
|
|
24
|
-
{
|
|
25
|
-
"name": "useSynonym",
|
|
26
|
-
"in": "query",
|
|
27
|
-
"description": "Whether to expand q with synonym dictionary terms (default: true)",
|
|
28
|
-
"schema": {
|
|
29
|
-
"type": "boolean",
|
|
30
|
-
"default": true
|
|
31
|
-
}
|
|
32
|
-
},
|
|
33
24
|
{
|
|
34
25
|
"name": "dept",
|
|
35
26
|
"in": "query",
|
|
@@ -9,11 +9,14 @@
|
|
|
9
9
|
"operationId": "get_7",
|
|
10
10
|
"summary": "Get worksheet template",
|
|
11
11
|
"description": "Returns a worksheet template. When search is provided, template headers are keyword-filtered.",
|
|
12
|
-
"tags": [
|
|
12
|
+
"tags": [
|
|
13
|
+
"Worksheet Templates"
|
|
14
|
+
],
|
|
13
15
|
"parameters": [
|
|
14
16
|
{
|
|
15
17
|
"name": "id",
|
|
16
18
|
"in": "path",
|
|
19
|
+
"description": "Worksheet template ID",
|
|
17
20
|
"required": true,
|
|
18
21
|
"schema": {
|
|
19
22
|
"type": "integer",
|
|
@@ -158,7 +161,9 @@
|
|
|
158
161
|
"operationId": "list_13",
|
|
159
162
|
"summary": "List worksheet templates",
|
|
160
163
|
"description": "Returns worksheet templates filtered by FMEA type. When fmeaType is omitted, returns all templates for Design, Process, Equipment, and FA types, ordered by type and template order.",
|
|
161
|
-
"tags": [
|
|
164
|
+
"tags": [
|
|
165
|
+
"Worksheet Templates"
|
|
166
|
+
],
|
|
162
167
|
"parameters": [
|
|
163
168
|
{
|
|
164
169
|
"name": "fmeaType",
|
|
@@ -6,13 +6,16 @@
|
|
|
6
6
|
{
|
|
7
7
|
"path": "/api/v2/projects/{projectId}/worksheets",
|
|
8
8
|
"method": "GET",
|
|
9
|
-
"summary": "
|
|
10
|
-
"description": "
|
|
11
|
-
"tags": [
|
|
9
|
+
"summary": "List worksheet summaries for a project",
|
|
10
|
+
"description": "Returns summary information for all worksheets belonging to the given project. Each summary includes the report number, title, and status. Requires NORMAL user level.",
|
|
11
|
+
"tags": [
|
|
12
|
+
"Worksheet"
|
|
13
|
+
],
|
|
12
14
|
"parameters": [
|
|
13
15
|
{
|
|
14
16
|
"name": "projectId",
|
|
15
17
|
"in": "path",
|
|
18
|
+
"description": "Project ID to list worksheets for",
|
|
16
19
|
"required": true,
|
|
17
20
|
"schema": {
|
|
18
21
|
"type": "string"
|
|
@@ -118,13 +121,16 @@
|
|
|
118
121
|
{
|
|
119
122
|
"path": "/api/v2/projects/{projectId}/worksheets",
|
|
120
123
|
"method": "POST",
|
|
121
|
-
"summary": "Create worksheet",
|
|
122
|
-
"description": "Creates a new worksheet
|
|
123
|
-
"tags": [
|
|
124
|
+
"summary": "Create a new worksheet in a project",
|
|
125
|
+
"description": "Creates a new worksheet under the given project using the provided creation DTO. Returns HTTP 201 Created with a Location header pointing to the new worksheet. Requires NORMAL user level and project MEMBER role.",
|
|
126
|
+
"tags": [
|
|
127
|
+
"Worksheet"
|
|
128
|
+
],
|
|
124
129
|
"parameters": [
|
|
125
130
|
{
|
|
126
131
|
"name": "projectId",
|
|
127
132
|
"in": "path",
|
|
133
|
+
"description": "Project ID to create the worksheet under",
|
|
128
134
|
"required": true,
|
|
129
135
|
"schema": {
|
|
130
136
|
"type": "string"
|
|
@@ -177,13 +183,16 @@
|
|
|
177
183
|
{
|
|
178
184
|
"path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
|
|
179
185
|
"method": "GET",
|
|
180
|
-
"summary": "Get worksheet by report number",
|
|
181
|
-
"description": "
|
|
182
|
-
"tags": [
|
|
186
|
+
"summary": "Get worksheet detail by report number",
|
|
187
|
+
"description": "Returns the full worksheet detail for the given report number within a project. Report number format: 'N' for primary only (e.g. '3'), or 'N-M' for primary-secondary (e.g. '3-1'). The '#' prefix is optional and will be stripped. Requires NORMAL user level.",
|
|
188
|
+
"tags": [
|
|
189
|
+
"Worksheet"
|
|
190
|
+
],
|
|
183
191
|
"parameters": [
|
|
184
192
|
{
|
|
185
193
|
"name": "projectId",
|
|
186
194
|
"in": "path",
|
|
195
|
+
"description": "Project ID the worksheet belongs to",
|
|
187
196
|
"required": true,
|
|
188
197
|
"schema": {
|
|
189
198
|
"type": "string"
|
|
@@ -192,6 +201,7 @@
|
|
|
192
201
|
{
|
|
193
202
|
"name": "reportNoSimple",
|
|
194
203
|
"in": "path",
|
|
204
|
+
"description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
|
|
195
205
|
"required": true,
|
|
196
206
|
"schema": {
|
|
197
207
|
"type": "string"
|
|
@@ -270,13 +280,16 @@
|
|
|
270
280
|
{
|
|
271
281
|
"path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
|
|
272
282
|
"method": "PUT",
|
|
273
|
-
"summary": "
|
|
274
|
-
"description": "
|
|
275
|
-
"tags": [
|
|
283
|
+
"summary": "Save worksheet data by report number",
|
|
284
|
+
"description": "Saves (updates) the worksheet content for the given report number. Accepts a WorksheetSaveDTO containing row data and column values. Requires NORMAL user level and project MEMBER role.",
|
|
285
|
+
"tags": [
|
|
286
|
+
"Worksheet"
|
|
287
|
+
],
|
|
276
288
|
"parameters": [
|
|
277
289
|
{
|
|
278
290
|
"name": "projectId",
|
|
279
291
|
"in": "path",
|
|
292
|
+
"description": "Project ID the worksheet belongs to",
|
|
280
293
|
"required": true,
|
|
281
294
|
"schema": {
|
|
282
295
|
"type": "string"
|
|
@@ -285,6 +298,7 @@
|
|
|
285
298
|
{
|
|
286
299
|
"name": "reportNoSimple",
|
|
287
300
|
"in": "path",
|
|
301
|
+
"description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
|
|
288
302
|
"required": true,
|
|
289
303
|
"schema": {
|
|
290
304
|
"type": "string"
|
|
@@ -419,13 +433,16 @@
|
|
|
419
433
|
{
|
|
420
434
|
"path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
|
|
421
435
|
"method": "DELETE",
|
|
422
|
-
"summary": "Delete worksheet",
|
|
423
|
-
"description": "
|
|
424
|
-
"tags": [
|
|
436
|
+
"summary": "Delete worksheet by report number",
|
|
437
|
+
"description": "Deletes the worksheet identified by the report number within the project. Returns HTTP 200 on success. Requires NORMAL user level and project MEMBER role.",
|
|
438
|
+
"tags": [
|
|
439
|
+
"Worksheet"
|
|
440
|
+
],
|
|
425
441
|
"parameters": [
|
|
426
442
|
{
|
|
427
443
|
"name": "projectId",
|
|
428
444
|
"in": "path",
|
|
445
|
+
"description": "Project ID the worksheet belongs to",
|
|
429
446
|
"required": true,
|
|
430
447
|
"schema": {
|
|
431
448
|
"type": "string"
|
|
@@ -434,6 +451,7 @@
|
|
|
434
451
|
{
|
|
435
452
|
"name": "reportNoSimple",
|
|
436
453
|
"in": "path",
|
|
454
|
+
"description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
|
|
437
455
|
"required": true,
|
|
438
456
|
"schema": {
|
|
439
457
|
"type": "string"
|
|
@@ -6,13 +6,16 @@
|
|
|
6
6
|
{
|
|
7
7
|
"path": "/api/v2/projects/{projectId}/worksheet-excel/{uuid}",
|
|
8
8
|
"method": "PUT",
|
|
9
|
-
"summary": "
|
|
10
|
-
"description": "Updates an existing worksheet by importing data from
|
|
11
|
-
"tags": [
|
|
9
|
+
"summary": "Re-import a worksheet from an uploaded Excel file",
|
|
10
|
+
"description": "Updates an existing worksheet by re-importing data from a previously uploaded Excel file. Overwrites the worksheet content according to the provided column mapping configuration. Returns 204 No Content on success.",
|
|
11
|
+
"tags": [
|
|
12
|
+
"Worksheet Excel"
|
|
13
|
+
],
|
|
12
14
|
"parameters": [
|
|
13
15
|
{
|
|
14
16
|
"name": "projectId",
|
|
15
17
|
"in": "path",
|
|
18
|
+
"description": "Project ID that owns the worksheet",
|
|
16
19
|
"required": true,
|
|
17
20
|
"schema": {
|
|
18
21
|
"type": "string"
|
|
@@ -21,6 +24,7 @@
|
|
|
21
24
|
{
|
|
22
25
|
"name": "uuid",
|
|
23
26
|
"in": "path",
|
|
27
|
+
"description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
|
|
24
28
|
"required": true,
|
|
25
29
|
"schema": {
|
|
26
30
|
"type": "string"
|
|
@@ -79,13 +83,16 @@
|
|
|
79
83
|
{
|
|
80
84
|
"path": "/api/v2/projects/{projectId}/worksheet-excel/{uuid}",
|
|
81
85
|
"method": "POST",
|
|
82
|
-
"summary": "
|
|
83
|
-
"description": "Creates a new worksheet by importing data from
|
|
84
|
-
"tags": [
|
|
86
|
+
"summary": "Import a new worksheet from an uploaded Excel file",
|
|
87
|
+
"description": "Creates a new worksheet by importing data from a previously uploaded Excel file. The file must be uploaded first via POST /api/v2/files. The request body specifies column mapping configuration. Returns the assigned report number (reportNoSetDTO) and a Location header pointing to the new worksheet.",
|
|
88
|
+
"tags": [
|
|
89
|
+
"Worksheet Excel"
|
|
90
|
+
],
|
|
85
91
|
"parameters": [
|
|
86
92
|
{
|
|
87
93
|
"name": "projectId",
|
|
88
94
|
"in": "path",
|
|
95
|
+
"description": "Project ID that will own the new worksheet",
|
|
89
96
|
"required": true,
|
|
90
97
|
"schema": {
|
|
91
98
|
"type": "string"
|
|
@@ -94,6 +101,7 @@
|
|
|
94
101
|
{
|
|
95
102
|
"name": "uuid",
|
|
96
103
|
"in": "path",
|
|
104
|
+
"description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
|
|
97
105
|
"required": true,
|
|
98
106
|
"schema": {
|
|
99
107
|
"type": "string"
|
|
@@ -152,13 +160,16 @@
|
|
|
152
160
|
{
|
|
153
161
|
"path": "/api/v2/projects/{projectId}/worksheet-excel/{reportNoSimple}",
|
|
154
162
|
"method": "GET",
|
|
155
|
-
"summary": "Get
|
|
156
|
-
"description": "Generates a download link for a worksheet Excel file
|
|
157
|
-
"tags": [
|
|
163
|
+
"summary": "Get Excel download link for a worksheet",
|
|
164
|
+
"description": "Generates and returns a download link (FileDownloadResponseDTO) for exporting a worksheet as an Excel file. The report number identifies the worksheet (primary 'N' or primary-secondary 'N-M'). Use GET /api/v1/files/{uuid} with the returned URI to download the file.",
|
|
165
|
+
"tags": [
|
|
166
|
+
"Worksheet Excel"
|
|
167
|
+
],
|
|
158
168
|
"parameters": [
|
|
159
169
|
{
|
|
160
170
|
"name": "projectId",
|
|
161
171
|
"in": "path",
|
|
172
|
+
"description": "Project ID that owns the worksheet",
|
|
162
173
|
"required": true,
|
|
163
174
|
"schema": {
|
|
164
175
|
"type": "string"
|
|
@@ -167,6 +178,7 @@
|
|
|
167
178
|
{
|
|
168
179
|
"name": "reportNoSimple",
|
|
169
180
|
"in": "path",
|
|
181
|
+
"description": "Worksheet report number: 'N' (primary) or 'N-M' (primary-secondary). '#' prefix is stripped.",
|
|
170
182
|
"required": true,
|
|
171
183
|
"schema": {
|
|
172
184
|
"type": "string"
|
|
@@ -198,13 +210,16 @@
|
|
|
198
210
|
{
|
|
199
211
|
"path": "/api/v2/projects/{projectId}/worksheet-excel/{uuid}/metadata",
|
|
200
212
|
"method": "GET",
|
|
201
|
-
"summary": "Get
|
|
202
|
-
"description": "
|
|
203
|
-
"tags": [
|
|
213
|
+
"summary": "Get Excel file metadata for a worksheet import",
|
|
214
|
+
"description": "Reads metadata (sheet names, column headers) from a previously uploaded Excel file. The file must be uploaded first via POST /api/v2/files. The returned metadata is used to configure mapping before triggering import.",
|
|
215
|
+
"tags": [
|
|
216
|
+
"Worksheet Excel"
|
|
217
|
+
],
|
|
204
218
|
"parameters": [
|
|
205
219
|
{
|
|
206
220
|
"name": "projectId",
|
|
207
221
|
"in": "path",
|
|
222
|
+
"description": "Project ID that owns the worksheet",
|
|
208
223
|
"required": true,
|
|
209
224
|
"schema": {
|
|
210
225
|
"type": "string"
|
|
@@ -213,6 +228,7 @@
|
|
|
213
228
|
{
|
|
214
229
|
"name": "uuid",
|
|
215
230
|
"in": "path",
|
|
231
|
+
"description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
|
|
216
232
|
"required": true,
|
|
217
233
|
"schema": {
|
|
218
234
|
"type": "string"
|
|
@@ -262,14 +278,17 @@
|
|
|
262
278
|
{
|
|
263
279
|
"path": "/api/v2/projects/{projectId}/worksheet-excel/{reportNoSimple}/sheets",
|
|
264
280
|
"method": "GET",
|
|
265
|
-
"summary": "
|
|
266
|
-
"description": "
|
|
267
|
-
"tags": [
|
|
281
|
+
"summary": "List POISheet sheets for a worksheet Excel",
|
|
282
|
+
"description": "Returns the list of POISheet sheet objects contained in the Excel file associated with the specified worksheet. Useful for rendering multi-sheet Excel content in the worksheet editor.",
|
|
283
|
+
"tags": [
|
|
284
|
+
"Worksheet Excel"
|
|
285
|
+
],
|
|
268
286
|
"operationId": "getSheets",
|
|
269
287
|
"parameters": [
|
|
270
288
|
{
|
|
271
289
|
"name": "projectId",
|
|
272
290
|
"in": "path",
|
|
291
|
+
"description": "Project ID that owns the worksheet",
|
|
273
292
|
"required": true,
|
|
274
293
|
"schema": {
|
|
275
294
|
"type": "string"
|
|
@@ -278,6 +297,7 @@
|
|
|
278
297
|
{
|
|
279
298
|
"name": "reportNoSimple",
|
|
280
299
|
"in": "path",
|
|
300
|
+
"description": "Worksheet report number: 'N' (primary) or 'N-M' (primary-secondary). '#' prefix is stripped.",
|
|
281
301
|
"required": true,
|
|
282
302
|
"schema": {
|
|
283
303
|
"type": "string"
|