· 2 years ago · Jul 18, 2023, 04:15 PM
1 "type": "string"
2 }
3 }
4 }
5 }
6 }
7 },
8 "/reusable-api-keys": {
9 "get": {
10 "tags": [
11 "reusable_api_keys"
12 ],
13 "description": "Finds User Preferences for applications",
14 "summary": "Find",
15 "parameters": [
16 {
17 "in": "query",
18 "name": "application_name",
19 "default": null,
20 "schema": {
21 "type": "string"
22 },
23 "description": "Filter on specific application"
24 }
25 ],
26 "responses": {
27 "200": {
28 "description": "A successful response"
29 }
30 }
31 },
32 "post": {
33 "tags": [
34 "reusable_api_keys"
35 ],
36 "summary": "Create",
37 "requestBody": {
38 "description": "Create a new reusable_api_keys",
39 "required": true,
40 "content": {
41 "application/json": {
42 "schema": {
43 "type": "object",
44 "properties": {
45 "application_name": {
46 "type": "string"
47 },
48 "application_token": {
49 "type": "string"
50 }
51 }
52 }
53 }
54 }
55 },
56 "responses": {
57 "201": {
58 "description": "Created"
59 }
60 }
61 },
62 "patch": {
63 "tags": [
64 "reusable_api_keys"
65 ],
66 "summary": "Update",
67 "requestBody": {
68 "description": "Update reusable_api_keys",
69 "required": true,
70 "content": {
71 "application/json": {
72 "schema": {
73 "type": "object",
74 "properties": {
75 "application_name": {
76 "type": "string"
77 },
78 "application_token": {
79 "type": "string"
80 }
81 }
82 }
83 }
84 }
85 },
86 "responses": {
87 "201": {
88 "description": "Updated"
89 }
90 }
91 },
92 "components": {
93 "responses": null,
94 "UnauthorizedError": {
95 "description": "API key is missing or invalid",
96 "headers": {
97 "WWW_Authenticate": {
98 "schema": {
99 "type": "string"
100 }
101 }
102 }
103 }
104 }
105 },
106 "/special-user-roles": {
107 "get": {
108 "tags": [
109 "special_user_roles"
110 ],
111 "description": "Finds special_user_roles",
112 "summary": "Find",
113 "parameters": [
114 {
115 "in": "query",
116 "name": "email",
117 "default": "someone@burlington.com",
118 "schema": {
119 "type": "string"
120 },
121 "description": "Filter on email"
122 },
123 {
124 "in": "query",
125 "name": "azure_id",
126 "default": "kl8asdc4",
127 "schema": {
128 "type": "string"
129 },
130 "description": "Find user based on azure id"
131 },
132 {
133 "in": "query",
134 "name": "ldap_id",
135 "default": "dsur123",
136 "schema": {
137 "type": "string"
138 },
139 "description": "Find user based on ldap id"
140 },
141 {
142 "in": "query",
143 "name": "special_role",
144 "default": "None",
145 "schema": {
146 "type": "string"
147 },
148 "description": "Find user based on special_role"
149 },
150 {
151 "in": "query",
152 "name": "offset",
153 "default": 0,
154 "schema": {
155 "type": "integer"
156 },
157 "description": "Offset this [integer] amount of records."
158 },
159 {
160 "in": "query",
161 "name": "limit",
162 "default": 10,
163 "schema": {
164 "type": "integer"
165 },
166 "description": "Return this [integer] amount of records."
167 }
168 ],
169 "responses": {
170 "200": {
171 "description": "A successful response"
172 }
173 }
174 },
175 "post": {
176 "tags": [
177 "special_user_roles"
178 ],
179 "summary": "Create",
180 "requestBody": {
181 "description": "Create new special role",
182 "required": true,
183 "content": {
184 "application/json": {
185 "schema": {
186 "type": "object",
187 "properties": {
188 "azure_id": {
189 "type": "string"
190 },
191 "email": {
192 "type": "string"
193 },
194 "ldap_id": {
195 "type": "string"
196 },
197 "special_role": {
198 "type": "string"
199 }
200 }
201 }
202 }
203 }
204 },
205 "responses": {
206 "201": {
207 "description": "Updated"
208 }
209 }
210 },
211 "patch": {
212 "tags": [
213 "special_user_roles"
214 ],
215 "summary": "Update",
216 "requestBody": {
217 "description": "Update special_user_roles",
218 "required": true,
219 "content": {
220 "application/json": {
221 "schema": {
222 "type": "object",
223 "properties": {
224 "email": {
225 "type": "string"
226 },
227 "azure_id": {
228 "type": "string"
229 },
230 "ldap_id": {
231 "type": "string"
232 },
233 "special_role": {
234 "type": "string"
235 }
236 }
237 }
238 }
239 }
240 },
241 "responses": {
242 "201": {
243 "description": "Updated"
244 }
245 }
246 },
247 "components": {
248 "responses": null,
249 "UnauthorizedError": {
250 "description": "API key is missing or invalid",
251 "headers": {
252 "WWW_Authenticate": {
253 "schema": {
254 "type": "string"
255 }
256 }
257 }
258 }
259 }
260 },
261 "/special-user-roles-history": {
262 "get": {
263 "tags": [
264 "special_user_roles_history"
265 ],
266 "description": "Find PO Approval Rule History Record for application",
267 "summary": "Find",
268 "parameters": [
269 {
270 "in": "query",
271 "name": "ldap_id",
272 "default": null,
273 "schema": {
274 "type": "string"
275 },
276 "description": "Filter on LDAP ID special_role"
277 },
278 {
279 "in": "query",
280 "name": "email",
281 "default": null,
282 "schema": {
283 "type": "string"
284 },
285 "description": "Filter on email e.g someone@burlington.com"
286 },
287 {
288 "in": "query",
289 "name": "special_role",
290 "default": null,
291 "schema": {
292 "type": "string"
293 },
294 "description": "Filter on special role value"
295 },
296 {
297 "in": "query",
298 "name": "limit",
299 "default": 10,
300 "schema": {
301 "type": "integer"
302 },
303 "description": "Return this [integer] amount of records."
304 }
305 ],
306 "responses": {
307 "200": {
308 "description": "A successful response"
309 }
310 }
311 },
312 "post": {
313 "tags": [
314 "special_user_roles_history"
315 ],
316 "summary": "Create",
317 "requestBody": {
318 "description": "Create new PO Approval Rule History Record",
319 "required": true,
320 "content": {
321 "application/json": {
322 "schema": {
323 "type": "object",
324 "properties": {
325 "ldap_id": {
326 "type": "string"
327 },
328 "email": {
329 "type": "string"
330 },
331 "special_role": {
332 "type": "string"
333 }
334 }
335 }
336 }
337 }
338 },
339 "responses": {
340 "201": {
341 "description": "Updated"
342 }
343 }
344 },
345 "patch": {
346 "tags": [
347 "special_user_roles_history"
348 ],
349 "summary": "Update",
350 "requestBody": {
351 "description": "Update PO Approval Rule Hitory Record",
352 "required": true,
353 "content": {
354 "application/json": {
355 "schema": {
356 "type": "object",
357 "properties": {
358 "ldap_id": {
359 "type": "string"
360 },
361 "email": {
362 "type": "string"
363 },
364 "special_role": {
365 "type": "string"
366 }
367 }
368 }
369 }
370 }
371 },
372 "responses": {
373 "201": {
374 "description": "Updated"
375 }
376 }
377 },
378 "components": {
379 "responses": null,
380 "UnauthorizedError": {
381 "description": "API key is missing or invalid",
382 "headers": {
383 "WWW_Authenticate": {
384 "schema": {
385 "type": "string"
386 }
387 }
388 }
389 }
390 }
391 },
392 "/user-preference-dmm-approval": {
393 "get": {
394 "tags": [
395 "user_preference_dmm_approval"
396 ],
397 "description": "Finds User Preferences for applications",
398 "summary": "Find",
399 "parameters": [
400 {
401 "in": "query",
402 "name": "user_id",
403 "default": null,
404 "schema": {
405 "type": "string"
406 },
407 "description": "Filter on User ID"
408 },
409 {
410 "in": "query",
411 "name": "proxy_user_id",
412 "default": null,
413 "schema": {
414 "type": "string"
415 },
416 "description": "Filter on Proxy User ID"
417 },
418 {
419 "in": "query",
420 "name": "notification_type",
421 "default": null,
422 "schema": {
423 "type": "number"
424 },
425 "description": "Filter on Notification Type"
426 },
427 {
428 "in": "query",
429 "name": "buyer_approval",
430 "default": null,
431 "schema": {
432 "type": "number"
433 },
434 "description": "Filter on Buyer Approval Flag"
435 },
436 {
437 "in": "query",
438 "name": "offset",
439 "default": 0,
440 "schema": {
441 "type": "integer"
442 },
443 "description": "Offset the result by this many records."
444 },
445 {
446 "in": "query",
447 "name": "limit",
448 "default": 10,
449 "schema": {
450 "type": "integer"
451 },
452 "description": "Return this [integer] amount of records."
453 }
454 ],
455 "responses": {
456 "200": {
457 "description": "A successful response"
458 }
459 }
460 },
461 "post": {
462 "tags": [
463 "user_preference_dmm_approval"
464 ],
465 "summary": "Create",
466 "requestBody": {
467 "description": "Create a new User Preference for application",
468 "required": true,
469 "content": {
470 "application/json": {
471 "schema": {
472 "type": "object",
473 "properties": {
474 "user_id": {
475 "type": "string"
476 },
477 "proxy_user_id": {
478 "type": "string"
479 },
480 "notification_type": {
481 "type": "integer"
482 },
483 "buyer_approval": {
484 "type": "integer"
485 }
486 }
487 }
488 }
489 }
490 },
491 "responses": {
492 "201": {
493 "description": "Created"
494 }
495 }
496 },
497 "patch": {
498 "tags": [
499 "user_preference_dmm_approval"
500 ],