repzo 1.0.141 → 1.0.142
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/docs/README.md +16 -315
- package/docs/api/activity-ai-sales-order-examples.md +63 -112
- package/docs/api/activity-ai-sales-order.md +15 -215
- package/docs/api/activity-feedback-examples.md +82 -136
- package/docs/api/activity-feedback-v2-examples.md +86 -138
- package/docs/api/activity-feedback-v2.md +19 -263
- package/docs/api/activity-feedback.md +19 -263
- package/docs/api/activity-storecheck-examples.md +62 -101
- package/docs/api/activity-storecheck.md +13 -186
- package/docs/api/adjust-account-examples.md +50 -78
- package/docs/api/adjust-account.md +12 -117
- package/docs/api/adjust-inventory-examples.md +50 -78
- package/docs/api/adjust-inventory.md +16 -121
- package/docs/api/approval-request-examples.md +58 -97
- package/docs/api/approval-request.md +26 -189
- package/docs/api/approvals-examples.md +58 -97
- package/docs/api/approvals.md +26 -189
- package/docs/api/asset-examples.md +53 -95
- package/docs/api/asset-part-examples.md +62 -101
- package/docs/api/asset-part-receival-examples.md +62 -101
- package/docs/api/asset-part-receival.md +13 -186
- package/docs/api/asset-part-transfer-examples.md +63 -112
- package/docs/api/asset-part-transfer.md +15 -215
- package/docs/api/asset-part-type-examples.md +62 -101
- package/docs/api/asset-part-type.md +13 -186
- package/docs/api/asset-part-unit-examples.md +62 -101
- package/docs/api/asset-part-unit.md +13 -186
- package/docs/api/asset-part.md +13 -186
- package/docs/api/asset-type-examples.md +58 -97
- package/docs/api/asset-type.md +26 -189
- package/docs/api/asset-unit-examples.md +80 -147
- package/docs/api/asset-unit.md +19 -306
- package/docs/api/asset.md +26 -189
- package/docs/api/banks-examples.md +53 -95
- package/docs/api/banks.md +26 -189
- package/docs/api/bankslists-examples.md +58 -97
- package/docs/api/bankslists.md +26 -189
- package/docs/api/brand-examples.md +58 -97
- package/docs/api/brand.md +18 -181
- package/docs/api/category-examples.md +58 -97
- package/docs/api/category.md +18 -181
- package/docs/api/checks-examples.md +45 -76
- package/docs/api/checks.md +12 -117
- package/docs/api/client-channel-examples.md +62 -101
- package/docs/api/client-channel.md +20 -207
- package/docs/api/client-contact-examples.md +62 -101
- package/docs/api/client-contact.md +25 -233
- package/docs/api/client-examples.md +53 -95
- package/docs/api/client-location-examples.md +71 -126
- package/docs/api/client-location.md +19 -275
- package/docs/api/client.md +18 -181
- package/docs/api/contract-examples.md +58 -97
- package/docs/api/contract-installment-examples.md +84 -148
- package/docs/api/contract-installment.md +21 -303
- package/docs/api/contract.md +26 -189
- package/docs/api/custom-list-examples.md +58 -97
- package/docs/api/custom-list-item-examples.md +58 -97
- package/docs/api/custom-list-item.md +26 -189
- package/docs/api/custom-list.md +26 -189
- package/docs/api/custom-status-examples.md +58 -97
- package/docs/api/custom-status.md +26 -189
- package/docs/api/day-examples.md +45 -76
- package/docs/api/day.md +12 -117
- package/docs/api/feedback-options-examples.md +90 -153
- package/docs/api/feedback-options.md +23 -307
- package/docs/api/fullinvoices-examples.md +51 -83
- package/docs/api/fullinvoices.md +22 -162
- package/docs/api/index.md +99 -705
- package/docs/api/integration-action-log-examples.md +62 -101
- package/docs/api/integration-action-log.md +13 -186
- package/docs/api/integration-app-examples.md +51 -83
- package/docs/api/integration-app.md +16 -156
- package/docs/api/integration-command-log-examples.md +62 -101
- package/docs/api/integration-command-log.md +13 -186
- package/docs/api/inventory-adjustment-reason-examples.md +58 -97
- package/docs/api/inventory-adjustment-reason.md +26 -189
- package/docs/api/inventory-examples.md +35 -45
- package/docs/api/inventory.md +8 -53
- package/docs/api/mail-unsubscribe-examples.md +69 -124
- package/docs/api/mail-unsubscribe.md +13 -251
- package/docs/api/measureunit-examples.md +58 -97
- package/docs/api/measureunit-family-examples.md +58 -97
- package/docs/api/measureunit-family.md +18 -188
- package/docs/api/measureunit.md +20 -190
- package/docs/api/media-examples.md +53 -95
- package/docs/api/media-storage-examples.md +58 -97
- package/docs/api/media-storage.md +18 -181
- package/docs/api/media.md +18 -181
- package/docs/api/msl-examples.md +53 -95
- package/docs/api/msl-products-examples.md +58 -97
- package/docs/api/msl-products.md +26 -189
- package/docs/api/msl.md +26 -189
- package/docs/api/ocr-invoice-job-examples.md +74 -132
- package/docs/api/ocr-invoice-job-group-examples.md +73 -121
- package/docs/api/ocr-invoice-job-group.md +15 -215
- package/docs/api/ocr-invoice-job-page-examples.md +63 -112
- package/docs/api/ocr-invoice-job-page.md +15 -215
- package/docs/api/ocr-invoice-job-template-examples.md +62 -101
- package/docs/api/ocr-invoice-job-template.md +13 -186
- package/docs/api/ocr-invoice-job.md +19 -253
- package/docs/api/patch-action-examples.md +63 -112
- package/docs/api/patch-action.md +15 -215
- package/docs/api/payment-terms-examples.md +58 -97
- package/docs/api/payment-terms.md +28 -198
- package/docs/api/payments-examples.md +51 -83
- package/docs/api/payments.md +22 -162
- package/docs/api/pricelist-examples.md +58 -97
- package/docs/api/pricelist-item-examples.md +58 -97
- package/docs/api/pricelist-item.md +24 -208
- package/docs/api/pricelist.md +18 -181
- package/docs/api/product-examples.md +58 -97
- package/docs/api/product-group-examples.md +58 -97
- package/docs/api/product-group.md +18 -181
- package/docs/api/product-modifiers-group-examples.md +70 -125
- package/docs/api/product-modifiers-group.md +19 -275
- package/docs/api/product.md +20 -190
- package/docs/api/proforma-examples.md +51 -83
- package/docs/api/proforma.md +22 -162
- package/docs/api/quick-convert-to-pdf-examples.md +30 -41
- package/docs/api/quick-convert-to-pdf.md +6 -56
- package/docs/api/receiving-material-examples.md +51 -83
- package/docs/api/receiving-material.md +16 -156
- package/docs/api/refund-examples.md +46 -81
- package/docs/api/refund.md +16 -156
- package/docs/api/rep-balance-summary-examples.md +36 -46
- package/docs/api/rep-balance-summary.md +6 -53
- package/docs/api/rep-examples.md +53 -95
- package/docs/api/rep.md +18 -181
- package/docs/api/return-asset-part-unit-examples.md +62 -101
- package/docs/api/return-asset-part-unit.md +13 -186
- package/docs/api/return-reason-examples.md +58 -97
- package/docs/api/return-reason.md +18 -181
- package/docs/api/route-examples.md +53 -95
- package/docs/api/route.md +18 -181
- package/docs/api/safe-invoice-serial-counter-examples.md +72 -127
- package/docs/api/safe-invoice-serial-counter.md +17 -266
- package/docs/api/settings-examples.md +47 -70
- package/docs/api/settings.md +18 -123
- package/docs/api/settlement-examples.md +50 -78
- package/docs/api/settlement.md +12 -117
- package/docs/api/speciality-examples.md +70 -125
- package/docs/api/speciality.md +17 -266
- package/docs/api/store-asset-part-unit-examples.md +62 -101
- package/docs/api/store-asset-part-unit.md +13 -186
- package/docs/api/storecheck-template-examples.md +58 -97
- package/docs/api/storecheck-template.md +18 -181
- package/docs/api/subcategory-examples.md +58 -97
- package/docs/api/subcategory.md +18 -181
- package/docs/api/supplier-examples.md +58 -97
- package/docs/api/supplier.md +26 -189
- package/docs/api/svix-integration-examples.md +62 -101
- package/docs/api/svix-integration.md +13 -186
- package/docs/api/tag-examples.md +53 -95
- package/docs/api/tag.md +18 -181
- package/docs/api/tax-examples.md +53 -95
- package/docs/api/tax.md +18 -181
- package/docs/api/team-examples.md +53 -95
- package/docs/api/team.md +18 -181
- package/docs/api/transfer-examples.md +51 -83
- package/docs/api/transfer.md +16 -156
- package/docs/api/update-integration-meta-examples.md +63 -112
- package/docs/api/update-integration-meta.md +15 -215
- package/docs/api/variant-examples.md +58 -97
- package/docs/api/variant.md +20 -183
- package/docs/api/visit-examples.md +46 -81
- package/docs/api/visit.md +22 -162
- package/docs/api/warehouse-examples.md +58 -97
- package/docs/api/warehouse.md +18 -181
- package/docs/api/workorder-category-examples.md +76 -141
- package/docs/api/workorder-category.md +19 -305
- package/docs/api/workorder-examples.md +58 -97
- package/docs/api/workorder-portal-examples.md +75 -132
- package/docs/api/workorder-portal-link-examples.md +70 -145
- package/docs/api/workorder-portal-link.md +23 -336
- package/docs/api/workorder-portal.md +19 -271
- package/docs/api/workorder-request-examples.md +58 -97
- package/docs/api/workorder-request.md +26 -189
- package/docs/api/workorder.md +26 -189
- package/docs/generated/index.html +1 -1
- package/docs/generated/repzo-api-complete.yaml +2585 -2585
- package/lib/index.d.ts +180 -0
- package/lib/index.js +90 -0
- package/lib/types/index.d.ts +13393 -14636
- package/package.json +2 -3
- package/src/types/index.ts +14 -1
|
@@ -6,54 +6,37 @@ API for managing workorder categories
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
|
|
10
9
|
### Base URLs
|
|
11
10
|
|
|
12
11
|
- **Production server**: `https://api.repzo.me/v1`
|
|
13
12
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
13
|
### API Categories
|
|
18
14
|
|
|
19
15
|
- **Workorder Category**: Workorder category management operations
|
|
20
16
|
|
|
21
|
-
|
|
22
|
-
|
|
23
17
|
## Authentication
|
|
24
18
|
|
|
25
|
-
|
|
26
19
|
This API uses the following authentication methods:
|
|
27
20
|
|
|
28
|
-
|
|
29
21
|
- **ApiKeyAuth**
|
|
30
22
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
23
|
## Endpoints
|
|
35
24
|
|
|
36
|
-
|
|
37
25
|
### `/workorder-category`
|
|
38
26
|
|
|
39
|
-
|
|
40
27
|
#### GET /workorder-category
|
|
41
28
|
|
|
42
29
|
**Summary:** Get all workorder categories
|
|
43
30
|
|
|
44
|
-
|
|
45
31
|
**Description:** Retrieve a list of all workorder categories with optional filtering and pagination
|
|
46
32
|
|
|
47
|
-
|
|
48
|
-
|
|
49
33
|
**Tags:** Workorder Category
|
|
50
34
|
|
|
51
|
-
|
|
52
|
-
|
|
53
35
|
##### Parameters
|
|
54
36
|
|
|
55
37
|
| Name | Location | Type | Required | Description |
|
|
56
|
-
|
|
38
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
39
|
+
|
|
57
40
|
|
|
58
41
|
| `page` | query | integer | No | Page number for pagination |
|
|
59
42
|
|
|
@@ -69,465 +52,231 @@ This API uses the following authentication methods:
|
|
|
69
52
|
|
|
70
53
|
| `_id` | query | array | No | Filter by ID |
|
|
71
54
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
55
|
##### Responses
|
|
77
56
|
|
|
78
|
-
|
|
79
57
|
**200** - Successful response
|
|
80
58
|
|
|
81
|
-
|
|
82
|
-
|
|
83
59
|
Content-Type: `application/json`
|
|
84
60
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
61
|
**400** - No description
|
|
89
62
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
63
|
**401** - No description
|
|
94
64
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
65
|
**403** - No description
|
|
99
66
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
67
|
**500** - No description
|
|
104
68
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
69
|
---
|
|
110
70
|
|
|
111
|
-
|
|
112
71
|
#### POST /workorder-category
|
|
113
72
|
|
|
114
73
|
**Summary:** Create a new workorder category
|
|
115
74
|
|
|
116
|
-
|
|
117
75
|
**Description:** Create a new workorder category
|
|
118
76
|
|
|
119
|
-
|
|
120
|
-
|
|
121
77
|
**Tags:** Workorder Category
|
|
122
78
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
79
|
##### Request Body
|
|
128
80
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
81
|
**Content Types:**
|
|
133
82
|
|
|
134
83
|
- `application/json`
|
|
135
84
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
85
|
##### Responses
|
|
140
86
|
|
|
141
|
-
|
|
142
87
|
**201** - Workorder category created successfully
|
|
143
88
|
|
|
144
|
-
|
|
145
|
-
|
|
146
89
|
Content-Type: `application/json`
|
|
147
90
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
91
|
**400** - No description
|
|
152
92
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
93
|
**401** - No description
|
|
157
94
|
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
95
|
**403** - No description
|
|
162
96
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
97
|
**422** - No description
|
|
167
98
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
99
|
**500** - No description
|
|
172
100
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
101
|
---
|
|
178
102
|
|
|
179
|
-
|
|
180
|
-
|
|
181
103
|
### `/workorder-category/{id}`
|
|
182
104
|
|
|
183
|
-
|
|
184
105
|
#### GET /workorder-category/{id}
|
|
185
106
|
|
|
186
107
|
**Summary:** Get workorder category by ID
|
|
187
108
|
|
|
188
|
-
|
|
189
109
|
**Description:** Retrieve a specific workorder category by its ID
|
|
190
110
|
|
|
191
|
-
|
|
192
|
-
|
|
193
111
|
**Tags:** Workorder Category
|
|
194
112
|
|
|
195
|
-
|
|
196
|
-
|
|
197
113
|
##### Parameters
|
|
198
114
|
|
|
199
115
|
| Name | Location | Type | Required | Description |
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
| `id` | path | string | Yes | Workorder category ID |
|
|
203
|
-
|
|
204
|
-
|
|
116
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
205
117
|
|
|
206
118
|
|
|
119
|
+
| `id` | path | string | Yes | Workorder category ID |
|
|
207
120
|
|
|
208
121
|
##### Responses
|
|
209
122
|
|
|
210
|
-
|
|
211
123
|
**200** - Successful response
|
|
212
124
|
|
|
213
|
-
|
|
214
|
-
|
|
215
125
|
Content-Type: `application/json`
|
|
216
126
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
127
|
**400** - No description
|
|
221
128
|
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
129
|
**401** - No description
|
|
226
130
|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
131
|
**403** - No description
|
|
231
132
|
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
133
|
**404** - No description
|
|
236
134
|
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
135
|
**500** - No description
|
|
241
136
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
137
|
---
|
|
247
138
|
|
|
248
|
-
|
|
249
139
|
#### PATCH /workorder-category/{id}
|
|
250
140
|
|
|
251
141
|
**Summary:** Update workorder category
|
|
252
142
|
|
|
253
|
-
|
|
254
143
|
**Description:** Update an existing workorder category
|
|
255
144
|
|
|
256
|
-
|
|
257
|
-
|
|
258
145
|
**Tags:** Workorder Category
|
|
259
146
|
|
|
260
|
-
|
|
261
|
-
|
|
262
147
|
##### Parameters
|
|
263
148
|
|
|
264
149
|
| Name | Location | Type | Required | Description |
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
| `id` | path | string | Yes | Workorder category ID |
|
|
268
|
-
|
|
150
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
269
151
|
|
|
270
152
|
|
|
153
|
+
| `id` | path | string | Yes | Workorder category ID |
|
|
271
154
|
|
|
272
155
|
##### Request Body
|
|
273
156
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
157
|
**Content Types:**
|
|
278
158
|
|
|
279
159
|
- `application/json`
|
|
280
160
|
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
161
|
##### Responses
|
|
285
162
|
|
|
286
|
-
|
|
287
163
|
**200** - Workorder category updated successfully
|
|
288
164
|
|
|
289
|
-
|
|
290
|
-
|
|
291
165
|
Content-Type: `application/json`
|
|
292
166
|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
167
|
**400** - No description
|
|
297
168
|
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
169
|
**401** - No description
|
|
302
170
|
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
171
|
**403** - No description
|
|
307
172
|
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
173
|
**404** - No description
|
|
312
174
|
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
175
|
**422** - No description
|
|
317
176
|
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
177
|
**500** - No description
|
|
322
178
|
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
179
|
---
|
|
328
180
|
|
|
329
|
-
|
|
330
181
|
#### DELETE /workorder-category/{id}
|
|
331
182
|
|
|
332
183
|
**Summary:** Delete workorder category
|
|
333
184
|
|
|
334
|
-
|
|
335
185
|
**Description:** Delete a workorder category by ID
|
|
336
186
|
|
|
337
|
-
|
|
338
|
-
|
|
339
187
|
**Tags:** Workorder Category
|
|
340
188
|
|
|
341
|
-
|
|
342
|
-
|
|
343
189
|
##### Parameters
|
|
344
190
|
|
|
345
191
|
| Name | Location | Type | Required | Description |
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
| `id` | path | string | Yes | Workorder category ID |
|
|
349
|
-
|
|
350
|
-
|
|
192
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
351
193
|
|
|
352
194
|
|
|
195
|
+
| `id` | path | string | Yes | Workorder category ID |
|
|
353
196
|
|
|
354
197
|
##### Responses
|
|
355
198
|
|
|
356
|
-
|
|
357
199
|
**200** - Workorder category deleted successfully
|
|
358
200
|
|
|
359
|
-
|
|
360
|
-
|
|
361
201
|
Content-Type: `application/json`
|
|
362
202
|
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
203
|
**400** - No description
|
|
367
204
|
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
205
|
**401** - No description
|
|
372
206
|
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
207
|
**403** - No description
|
|
377
208
|
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
209
|
**404** - No description
|
|
382
210
|
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
211
|
**500** - No description
|
|
387
212
|
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
213
|
---
|
|
393
214
|
|
|
394
|
-
|
|
395
|
-
|
|
396
215
|
### `/workorder-category/remove`
|
|
397
216
|
|
|
398
|
-
|
|
399
217
|
#### POST /workorder-category/remove
|
|
400
218
|
|
|
401
219
|
**Summary:** Bulk delete workorder categories
|
|
402
220
|
|
|
403
|
-
|
|
404
221
|
**Description:** Delete multiple workorder categories by their IDs
|
|
405
222
|
|
|
406
|
-
|
|
407
|
-
|
|
408
223
|
**Tags:** Workorder Category
|
|
409
224
|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
225
|
##### Request Body
|
|
415
226
|
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
227
|
**Content Types:**
|
|
420
228
|
|
|
421
229
|
- `application/json`
|
|
422
230
|
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
231
|
##### Responses
|
|
427
232
|
|
|
428
|
-
|
|
429
233
|
**200** - Workorder categories deleted successfully
|
|
430
234
|
|
|
431
|
-
|
|
432
|
-
|
|
433
235
|
Content-Type: `application/json`
|
|
434
236
|
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
237
|
**400** - No description
|
|
439
238
|
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
239
|
**401** - No description
|
|
444
240
|
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
241
|
**403** - No description
|
|
449
242
|
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
243
|
**500** - No description
|
|
454
244
|
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
245
|
---
|
|
460
246
|
|
|
461
|
-
|
|
462
|
-
|
|
463
247
|
### `/workorder-category/hierarchy`
|
|
464
248
|
|
|
465
|
-
|
|
466
249
|
#### GET /workorder-category/hierarchy
|
|
467
250
|
|
|
468
251
|
**Summary:** Get category hierarchy
|
|
469
252
|
|
|
470
|
-
|
|
471
253
|
**Description:** Get workorder categories in hierarchical structure
|
|
472
254
|
|
|
473
|
-
|
|
474
|
-
|
|
475
255
|
**Tags:** Workorder Category
|
|
476
256
|
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
257
|
##### Responses
|
|
483
258
|
|
|
484
|
-
|
|
485
259
|
**200** - Category hierarchy retrieved successfully
|
|
486
260
|
|
|
487
|
-
|
|
488
|
-
|
|
489
261
|
Content-Type: `application/json`
|
|
490
262
|
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
263
|
**400** - No description
|
|
495
264
|
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
265
|
**401** - No description
|
|
500
266
|
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
267
|
**403** - No description
|
|
505
268
|
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
269
|
**500** - No description
|
|
510
270
|
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
271
|
---
|
|
516
272
|
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
273
|
## Data Models
|
|
521
274
|
|
|
522
|
-
|
|
523
|
-
|
|
524
275
|
### WorkorderCategory
|
|
525
276
|
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
277
|
| Property | Type | Required | Description |
|
|
530
|
-
|
|
278
|
+
| -------- | ---- | -------- | ----------- |
|
|
279
|
+
|
|
531
280
|
|
|
532
281
|
| `_id` | string | No | Unique identifier |
|
|
533
282
|
|
|
@@ -573,18 +322,11 @@ Content-Type: `application/json`
|
|
|
573
322
|
|
|
574
323
|
| `__v` | integer | No | Document version |
|
|
575
324
|
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
325
|
### WorkorderCategoryHierarchy
|
|
582
326
|
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
327
|
| Property | Type | Required | Description |
|
|
587
|
-
|
|
328
|
+
| -------- | ---- | -------- | ----------- |
|
|
329
|
+
|
|
588
330
|
|
|
589
331
|
| `_id` | string | No | Category ID |
|
|
590
332
|
|
|
@@ -602,18 +344,11 @@ Content-Type: `application/json`
|
|
|
602
344
|
|
|
603
345
|
| `workorder_count` | integer | No | Number of workorders in this category |
|
|
604
346
|
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
347
|
### CreateWorkorderCategoryRequest
|
|
611
348
|
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
349
|
| Property | Type | Required | Description |
|
|
616
|
-
|
|
350
|
+
| -------- | ---- | -------- | ----------- |
|
|
351
|
+
|
|
617
352
|
|
|
618
353
|
| `name` | string | Yes | Category name |
|
|
619
354
|
|
|
@@ -649,18 +384,11 @@ Content-Type: `application/json`
|
|
|
649
384
|
|
|
650
385
|
| `disabled` | boolean | No | Whether the category is disabled |
|
|
651
386
|
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
387
|
### UpdateWorkorderCategoryRequest
|
|
658
388
|
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
389
|
| Property | Type | Required | Description |
|
|
663
|
-
|
|
390
|
+
| -------- | ---- | -------- | ----------- |
|
|
391
|
+
|
|
664
392
|
|
|
665
393
|
| `name` | string | No | Category name |
|
|
666
394
|
|
|
@@ -696,18 +424,11 @@ Content-Type: `application/json`
|
|
|
696
424
|
|
|
697
425
|
| `disabled` | boolean | No | Whether the category is disabled |
|
|
698
426
|
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
427
|
### PagingInfo
|
|
705
428
|
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
429
|
| Property | Type | Required | Description |
|
|
710
|
-
|
|
430
|
+
| -------- | ---- | -------- | ----------- |
|
|
431
|
+
|
|
711
432
|
|
|
712
433
|
| `total` | integer | No | Total number of items |
|
|
713
434
|
|
|
@@ -717,13 +438,6 @@ Content-Type: `application/json`
|
|
|
717
438
|
|
|
718
439
|
| `pages` | integer | No | Total number of pages |
|
|
719
440
|
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
441
|
## TypeScript Usage
|
|
728
442
|
|
|
729
|
-
See [workorder-category-examples.md](./workorder-category-examples.md) for detailed TypeScript usage examples.
|
|
443
|
+
See [workorder-category-examples.md](./workorder-category-examples.md) for detailed TypeScript usage examples.
|