Gitiles
Code Review Sign In
source.supwisdom.com / institute / deploy-authx-service / c7dcdd0e67dca2a6c889b84ba393cdf67a202c24 / . / poa-api-docs / api-docs / user-data-service-poa.v1.yaml
blob: 1d7f77ed425e237b6a34fc46889d4b1d665ccee7 [file] [log] [blame]
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]1# user-data-service-poa.v1.yaml
2#
3# 1. 创建服务
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]4# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services' -H 'Content-Type: application/json' -d '{"id": "user", "origin": "https://user-api.supwisdom.com", "name": "用户服务", "description": "用户服务"}'
5# http://user-data-service-poa-svc.user-data-service.svc.cluster.local:8080
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]6#
7# 2. 创建版本
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]8# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services/user/apiVersions/v1'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]9#
10# 3. 上传OAS Yaml
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]11# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services/user/apiVersions/v1/apiSpecs' -H 'Content-Type: application/yaml' -d 'yaml content'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]12#
13# 4. 发布版本
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]14# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services/user/apiVersions/v1/publish'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]15#
16openapi: 3.0.2
17info:
18 title: User Data Service Platform Open APIs
19 version: v1
20 description: '用户服务 - 平台开放接口'
21servers:
22 - url: '${POA_SERVER_URL}/apis/user/v1'
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]23 description: '演示环境'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]24tags:
25 - name: User
26 description: '用户'
27 - name: UserBatchQuery
28 description: '用户批量查询'
29 - name: Organization
30 description: '组织机构'
31 - name: Group
32 description: '用户组'
33 - name: Label
34 description: '用户标签'
35 - name: PostAdmin
36 description: '用户组（岗位）管理'
37
38paths:
39
40 '/users':
41 get:
42 summary: 获取用户列表
43 operationId: pageUsers
44 tags:
45 - User
46 security:
47 - oauth2:
48 - "user:v1:readUser"
49 parameters:
50 - name: pageIndex
51 in: query
52 required: true
53 description: 分页-页码
54 schema:
55 type: integer
56 format: int32
57 default: 0
58 - name: pageSize
59 in: query
60 required: true
61 description: 分页-每页记录数
62 schema:
63 type: integer
64 format: int32
65 default: 20
66 - name: mapBean
67 in: query
68 required: false
69 description: 查询条件
70 style: deepObject
71 explode: true
72 schema:
73 type: object
74 properties:
75 keyword:
76 title: 查询条件 - 关键字(模糊，帐号、姓名等)
77 type: string
78 accountName:
79 title: 查询条件 - 账户名(模糊)
80 type: string
81 name:
82 title: 查询条件 - 姓名(模糊)
83 type: string
84 ids:
85 title: 查询条件 - ids（精确匹配，多个用逗号隔开）
86 type: string
87 accountNames:
88 title: 查询条件 - 账户名s（精确匹配，多个用逗号隔开）
89 type: string
90 responses:
91 '200':
92 description: 用户分页列表
93 content:
94 application/json:
95 schema:
96 $ref: '#/components/schemas/UserInfoPageResponse'
97 default:
98 $ref: '#/components/responses/DefaultErrorResponse'
99
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]100 '/users/newPage':
101 get:
102 summary: 获取用户列表(不计算totalCount)
103 operationId: pageUsersNew
104 tags:
105 - User
106 security:
107 - oauth2:
108 - "user:v1:readUser"
109 parameters:
110 - name: pageIndex
111 in: query
112 required: true
113 description: 分页-页码
114 schema:
115 type: integer
116 format: int32
117 default: 0
118 - name: pageSize
119 in: query
120 required: true
121 description: 分页-每页记录数
122 schema:
123 type: integer
124 format: int32
125 default: 20
126 - name: mapBean
127 in: query
128 required: false
129 description: 查询条件
130 style: deepObject
131 explode: true
132 schema:
133 type: object
134 properties:
135 keyword:
136 title: 查询条件 - 关键字(模糊，帐号、姓名等)
137 type: string
138 accountName:
139 title: 查询条件 - 账户名(模糊)
140 type: string
141 name:
142 title: 查询条件 - 姓名(模糊)
143 type: string
144 ids:
145 title: 查询条件 - ids（精确匹配，多个用逗号隔开）
146 type: string
147 accountNames:
148 title: 查询条件 - 账户名s（精确匹配，多个用逗号隔开）
149 type: string
150 responses:
151 '200':
152 description: 用户分页列表
153 content:
154 application/json:
155 schema:
156 $ref: '#/components/schemas/UserInfoPageResponse'
157 default:
158 $ref: '#/components/responses/DefaultErrorResponse'
159
160 '/users/totalCount':
161 get:
162 summary: 根据查询条件得到用户数量
163 operationId: totalCount
164 tags:
165 - User
166 security:
167 - oauth2:
168 - "user:v1:readUser"
169 parameters:
170 - name: mapBean
171 in: query
172 required: false
173 description: 查询条件
174 style: deepObject
175 explode: true
176 schema:
177 type: object
178 properties:
179 keyword:
180 title: 查询条件 - 关键字(模糊，帐号、姓名等)
181 type: string
182 accountName:
183 title: 查询条件 - 账户名(模糊)
184 type: string
185 name:
186 title: 查询条件 - 姓名(模糊)
187 type: string
188 ids:
189 title: 查询条件 - ids（精确匹配，多个用逗号隔开）
190 type: string
191 accountNames:
192 title: 查询条件 - 账户名s（精确匹配，多个用逗号隔开）
193 type: string
194 responses:
195 '200':
196 description: 用户数量
197 content:
198 application/json:
199 schema:
200 $ref: '#/components/schemas/UserTotalCountResponse'
201 default:
202 $ref: '#/components/responses/DefaultErrorResponse'
203
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]204 '/users/{accountId}':
205 get:
206 summary: 根据帐号ID获取用户信息
207 operationId: loadUserInfoByAccountId
208 tags:
209 - User
210 security:
211 - oauth2:
212 - "user:v1:readUser"
213 parameters:
214 - name: accountId
215 in: path
216 required: true
217 description: 帐号ID
218 schema:
219 type: string
220 responses:
221 '200':
222 description: 用户信息
223 content:
224 application/json:
225 schema:
226 $ref: '#/components/schemas/UserInfoLoadResponse'
227 default:
228 $ref: '#/components/responses/DefaultErrorResponse'
229
230 '/users/accountName/{accountName}':
231 get:
232 summary: 根据帐号获取用户信息
233 operationId: loadUserInfoByAccountName
234 tags:
235 - User
236 security:
237 - oauth2:
238 - "user:v1:readUser"
239 parameters:
240 - name: accountName
241 in: path
242 required: true
243 description: 用户名
244 schema:
245 type: string
246 responses:
247 '200':
248 description: 用户信息
249 content:
250 application/json:
251 schema:
252 $ref: '#/components/schemas/UserInfoLoadResponse'
253 default:
254 $ref: '#/components/responses/DefaultErrorResponse'
255
256
257 '/users/phoneNumber/{phoneNumber}':
258 get:
259 summary: 根据手机号（安全手机）获取用户列表
260 operationId: listUsersByPhoneNumber
261 tags:
262 - User
263 security:
264 - oauth2:
265 - "user:v1:readUser"
266 parameters:
267 - name: phoneNumber
268 in: path
269 required: true
270 description: 手机号（安全手机）
271 schema:
272 type: string
273 responses:
274 '200':
275 description: 用户列表
276 content:
277 application/json:
278 schema:
279 $ref: '#/components/schemas/UserInfoListResponse'
280 default:
281 $ref: '#/components/responses/DefaultErrorResponse'
282
283 '/users/email/{email}':
284 get:
285 summary: 根据邮件地址（安全邮箱）获取用户列表
286 operationId: listUsersByEmail
287 tags:
288 - User
289 security:
290 - oauth2:
291 - "user:v1:readUser"
292 parameters:
293 - name: email
294 in: path
295 required: true
296 description: 邮件地址（安全邮箱）
297 schema:
298 type: string
299 responses:
300 '200':
301 description: 用户列表
302 content:
303 application/json:
304 schema:
305 $ref: '#/components/schemas/UserInfoListResponse'
306 default:
307 $ref: '#/components/responses/DefaultErrorResponse'
308
309 '/users/{accountId}/portrait':
310 get:
311 summary: 根据帐号ID获取用户头像
312 operationId: loadUserPortraitByAccountId
313 tags:
314 - User
315 security:
316 - oauth2:
317 - "user:v1:readUser"
318 parameters:
319 - name: accountId
320 in: path
321 required: true
322 description: 帐号ID
323 schema:
324 type: string
325 responses:
326 '200':
327 description: 用户头像
328 content:
329 application/json:
330 schema:
331 $ref: '#/components/schemas/UserPortraitLoadResponse'
332 default:
333 $ref: '#/components/responses/DefaultErrorResponse'
334
335 '/users/accountName/{accountName}/portrait':
336 get:
337 summary: 根据帐号获取用户头像
338 operationId: loadUserPortraitByAccountName
339 tags:
340 - User
341 security:
342 - oauth2:
343 - "user:v1:readUser"
344 parameters:
345 - name: accountName
346 in: path
347 required: true
348 description: 帐号
349 schema:
350 type: string
351 responses:
352 '200':
353 description: 用户头像
354 content:
355 application/json:
356 schema:
357 $ref: '#/components/schemas/UserPortraitLoadResponse'
358 default:
359 $ref: '#/components/responses/DefaultErrorResponse'
360
361 '/users/{accountId}/safety':
362 get:
363 summary: 根据帐号ID获取用户的安全信息
364 operationId: loadUserSafetyByAccountId
365 tags:
366 - User
367 security:
368 - oauth2:
369 - "user:v1:readUserSecret"
370 parameters:
371 - name: accountId
372 in: path
373 required: true
374 description: 帐号ID
375 schema:
376 type: string
377 responses:
378 '200':
379 description: 安全信息
380 content:
381 application/json:
382 schema:
383 $ref: '#/components/schemas/UserSafetyLoadResponse'
384 default:
385 $ref: '#/components/responses/DefaultErrorResponse'
386
387 '/users/accountName/{accountName}/safety':
388 get:
389 summary: 根据帐号获取用户的安全信息
390 operationId: loadUserSafetyByAccountName
391 tags:
392 - User
393 security:
394 - oauth2:
395 - "user:v1:readUserSecret"
396 parameters:
397 - name: accountName
398 in: path
399 required: true
400 description: 帐号
401 schema:
402 type: string
403 responses:
404 '200':
405 description: 安全信息
406 content:
407 application/json:
408 schema:
409 $ref: '#/components/schemas/UserSafetyLoadResponse'
410 default:
411 $ref: '#/components/responses/DefaultErrorResponse'
412
413 '/users/{accountId}/federation/{federatedType}':
414 get:
415 summary: 根据帐号ID获取用户的联合登录信息
416 operationId: loadUserFederationByAccountId
417 tags:
418 - User
419 security:
420 - oauth2:
421 - "user:v1:readUserSecret"
422 parameters:
423 - name: accountId
424 in: path
425 required: true
426 description: 帐号ID
427 schema:
428 type: string
429 - name: federatedType
430 in: path
431 required: true
432 description: 联合登录类型（qq, openweixin, workweixin, alipay, dingtalk）
433 schema:
434 type: string
435 responses:
436 '200':
437 description: 联合登录信息
438 content:
439 application/json:
440 schema:
441 $ref: '#/components/schemas/UserFederationLoadResponse'
442 default:
443 $ref: '#/components/responses/DefaultErrorResponse'
444
445 '/users/accountName/{accountName}/federation/{federatedType}':
446 get:
447 summary: 根据帐号获取用户的联合登录信息
448 operationId: loadUserFederationByAccountName
449 tags:
450 - User
451 security:
452 - oauth2:
453 - "user:v1:readUserSecret"
454 parameters:
455 - name: accountName
456 in: path
457 required: true
458 description: 帐号
459 schema:
460 type: string
461 - name: federatedType
462 in: path
463 required: true
464 description: 联合登录类型（qq, openweixin, workweixin, alipay, dingtalk）
465 schema:
466 type: string
467 responses:
468 '200':
469 description: 联合登录信息
470 content:
471 application/json:
472 schema:
473 $ref: '#/components/schemas/UserFederationLoadResponse'
474 default:
475 $ref: '#/components/responses/DefaultErrorResponse'
476
477
478 '/users/batchQuery':
479 post:
480 summary: 批量获取用户列表
481 operationId: batchQueryUsers
482 description: |-
483 查询条件accountIds, accountNames, phoneNumbers, emails之间的是或关系。
484 如果你同时制定了accountIds和phoneNumbers，那么会分别按照这两个查询条件
485 查询出用户列表，然后合并返回给你。
486 同时，这些查询条件的数组长度最多1000个
487 tags:
488 - UserBatchQuery
489 security:
490 - oauth2:
491 - "user:v1:readUser"
492 requestBody:
493 description: 查询条件
494 required: true
495 content:
496 'application/json':
497 schema:
498 type: object
499 properties:
500 accountIds:
501 title: 账号Id（复数）
502 type: array
503 items:
504 title: 账号Id
505 type: string
506 maxItems: 1000
507 accountNames:
508 title: 账户名（复数）
509 type: array
510 items:
511 title: 账户名
512 type: string
513 maxItems: 1000
514 securePhoneNumbers:
515 title: 安全手机（复数）
516 type: array
517 items:
518 title: 安全手机
519 type: string
520 maxItems: 1000
521 secureEmails:
522 title: 安全邮箱（复数）
523 type: array
524 items:
525 title: 安全邮箱
526 type: string
527 maxItems: 1000
528 responses:
529 '200':
530 description: 用户列表
531 content:
532 application/json:
533 schema:
534 $ref: '#/components/schemas/UserInfoListResponse'
535 default:
536 $ref: '#/components/responses/DefaultErrorResponse'
537
538 '/users/safety/phoneNumber/batchQuery':
539 post:
540 summary: 批量查询用户的安全手机
541 operationId: batchQueryUserSafetyPhoneNumber
542 description: |-
543 查询条件accountIds, accountNames之间的是或关系。
544 如果你同时制定了accountIds和accountNames，那么会分别按照这两个查询条件
545 查询出用户列表，然后合并返回给你。
546 同时，这些查询条件的数组长度最多1000个
547 tags:
548 - UserBatchQuery
549 security:
550 - oauth2:
551 - "user:v1:readUserSecret"
552 requestBody:
553 description: 查询条件
554 required: true
555 content:
556 'application/json':
557 schema:
558 type: object
559 properties:
560 accountIds:
561 title: 账号Id（复数）
562 type: array
563 items:
564 title: 账号Id
565 type: string
566 maxItems: 1000
567 accountNames:
568 title: 账户名（复数）
569 type: array
570 items:
571 title: 账户名
572 type: string
573 maxItems: 1000
574 responses:
575 '200':
576 description: 用户安全信息列表
577 content:
578 application/json:
579 schema:
580 $ref: '#/components/schemas/UserSafetyPhoneNumberList'
581 default:
582 $ref: '#/components/responses/DefaultErrorResponse'
583
584 '/users/safety/email/batchQuery':
585 post:
586 summary: 批量查询用户的安全邮箱
587 operationId: batchQueryUserSafetyEmail
588 description: |-
589 查询条件accountIds, accountNames之间的是或关系。
590 如果你同时制定了accountIds和accountNames，那么会分别按照这两个查询条件
591 查询出用户列表，然后合并返回给你。
592 同时，这些查询条件的数组长度最多1000个
593 tags:
594 - UserBatchQuery
595 security:
596 - oauth2:
597 - "user:v1:readUserSecret"
598 requestBody:
599 description: 查询条件
600 required: true
601 content:
602 'application/json':
603 schema:
604 type: object
605 properties:
606 accountIds:
607 title: 账号Id（复数）
608 type: array
609 items:
610 title: 账号Id
611 type: string
612 maxItems: 1000
613 accountNames:
614 title: 账户名（复数）
615 type: array
616 items:
617 title: 账户名
618 type: string
619 maxItems: 1000
620 responses:
621 '200':
622 description: 用户安全信息列表
623 content:
624 application/json:
625 schema:
626 $ref: '#/components/schemas/UserSafetyEmailList'
627 default:
628 $ref: '#/components/responses/DefaultErrorResponse'
629
630 '/users/federation/{federatedType}/batchQuery':
631 post:
632 summary: 批量查询用户的联合登录信息
633 operationId: batchQueryUserFederation
634 description: |-
635 查询条件accountIds, accountNames之间的是或关系。
636 如果你同时制定了accountIds和accountNames，那么会分别按照这两个查询条件
637 查询出用户列表，然后合并返回给你。
638 同时，这些查询条件的数组长度最多1000个
639 tags:
640 - UserBatchQuery
641 security:
642 - oauth2:
643 - "user:v1:readUserSecret"
644 parameters:
645 - name: federatedType
646 description: 联合登录类型
647 in: path
648 required: true
649 schema:
650 type: string
651 enum:
652 - qq
653 - openweixin
654 - workweixin
655 - alipay
656 - dingtalk
657 requestBody:
658 description: 查询条件
659 required: true
660 content:
661 'application/json':
662 schema:
663 type: object
664 properties:
665 accountIds:
666 title: 账号Id（复数）
667 type: array
668 items:
669 title: 账号Id
670 type: string
671 maxItems: 1000
672 accountNames:
673 title: 账户名（复数）
674 type: array
675 items:
676 title: 账户名
677 type: string
678 maxItems: 1000
679 responses:
680 '200':
681 description: 用户联合登录信息列表
682 content:
683 application/json:
684 schema:
685 $ref: '#/components/schemas/UserFederationList'
686 default:
687 $ref: '#/components/responses/DefaultErrorResponse'
688
689
690 '/organizations/organizationTree':
691 get:
692 summary: 获取组织机构树
693 operationId: treeOrganization
694 tags:
695 - Organization
696 security:
697 - oauth2:
698 - "user:v1:readOrganization"
699 responses:
700 '200':
701 description: 组织机构列表
702 content:
703 application/json:
704 schema:
705 $ref: '#/components/schemas/OrganizationListResponse'
706 default:
707 $ref: '#/components/responses/DefaultErrorResponse'
708
709 '/organizations/rootOrganization':
710 get:
711 summary: 获取根组织机构列表
712 operationId: listRootOrganization
713 tags:
714 - Organization
715 security:
716 - oauth2:
717 - "user:v1:readOrganization"
718 responses:
719 '200':
720 description: 根组织机构列表
721 content:
722 application/json:
723 schema:
724 $ref: '#/components/schemas/RootOrganizationListResponse'
725 default:
726 $ref: '#/components/responses/DefaultErrorResponse'
727
728 '/organizations/rootOrganization/{rootOrganizationId}/organizations':
729 get:
730 summary: 获取根组织机构下的组织机构列表
731 operationId: pageOrganizationsOfRoot
732 tags:
733 - Organization
734 security:
735 - oauth2:
736 - "user:v1:readOrganization"
737 parameters:
738 - name: rootOrganizationId
739 in: path
740 required: true
741 description: 根组织机构ID
742 schema:
743 type: string
744 - name: pageIndex
745 in: query
746 required: true
747 description: 分页-页码
748 schema:
749 type: integer
750 format: int32
751 default: 0
752 - name: pageSize
753 in: query
754 required: true
755 description: 分页-每页记录数
756 schema:
757 type: integer
758 format: int32
759 default: 20
760 - name: mapBean
761 in: query
762 required: false
763 description: 查询条件
764 style: deepObject
765 explode: true
766 schema:
767 type: object
768 properties:
769 ids:
770 title: 查询条件 - IDs(多个用逗号隔开)
771 type: string
772 keyword:
773 title: 查询条件 - 关键字(模糊，代码、名称、描述等)
774 type: string
775 code:
776 title: 查询条件 - 代码(模糊)
777 type: string
778 name:
779 title: 查询条件 - 名称(模糊)
780 type: string
781 description:
782 title: 查询条件 - 描述(模糊)
783 type: string
784 responses:
785 '200':
786 description: 组织机构列表
787 content:
788 application/json:
789 schema:
790 $ref: '#/components/schemas/OrganizationListResponse'
791 default:
792 $ref: '#/components/responses/DefaultErrorResponse'
793
794 '/organizations/rootOrganization/{rootOrganizationId}/organizationTree':
795 get:
796 summary: 获取根组织机构下的组织机构树
797 operationId: treeOrganizationsOfRoot
798 tags:
799 - Organization
800 security:
801 - oauth2:
802 - "user:v1:readOrganization"
803 parameters:
804 - name: rootOrganizationId
805 in: path
806 required: true
807 description: 根组织机构ID
808 schema:
809 type: string
810 responses:
811 '200':
812 description: 组织机构列表
813 content:
814 application/json:
815 schema:
816 $ref: '#/components/schemas/OrganizationListResponse'
817 default:
818 $ref: '#/components/responses/DefaultErrorResponse'
819
820
821 '/organizations/{organizationId}':
822 get:
823 summary: 根据组织机构ID获取组织机构
824 operationId: getOrganization
825 tags:
826 - Organization
827 security:
828 - oauth2:
829 - "user:v1:readOrganization"
830 parameters:
831 - name: organizationId
832 in: path
833 required: true
834 description: 组织机构ID
835 schema:
836 type: string
837 responses:
838 '200':
839 description: 组织机构信息
840 content:
841 application/json:
842 schema:
843 $ref: '#/components/schemas/OrganizationLoadResponse'
844 default:
845 $ref: '#/components/responses/DefaultErrorResponse'
846
847 '/organizations/organizationCode/{organizationCode}':
848 get:
849 summary: 根据组织机构代码获取组织机构
850 operationId: getOrganizationByCode
851 tags:
852 - Organization
853 security:
854 - oauth2:
855 - "user:v1:readOrganization"
856 parameters:
857 - name: organizationCode
858 in: path
859 required: true
860 description: 组织机构代码
861 schema:
862 type: string
863 responses:
864 '200':
865 description: 组织机构信息
866 content:
867 application/json:
868 schema:
869 $ref: '#/components/schemas/OrganizationLoadResponse'
870 default:
871 $ref: '#/components/responses/DefaultErrorResponse'
872
873
874 '/organizations/{organizationId}/users':
875 get:
876 summary: 获取组织机构下的用户列表（弃用）
877 description: 弃用，应该使用 /organizations/users
878 operationId: listUsersByOrganization
879 tags:
880 - Organization
881 security:
882 - oauth2:
883 - "user:v1:readOrganization"
884 parameters:
885 - name: organizationId
886 in: path
887 required: true
888 description: 组织机构ID
889 schema:
890 type: string
891 - name: pageIndex
892 in: query
893 required: true
894 description: 分页-页码
895 schema:
896 type: integer
897 format: int32
898 default: 0
899 - name: pageSize
900 in: query
901 required: true
902 description: 分页-每页记录数
903 schema:
904 type: integer
905 format: int32
906 default: 20
907 - name: mapBean
908 in: query
909 required: false
910 description: 查询条件
911 style: deepObject
912 explode: true
913 schema:
914 type: object
915 properties:
916 keyword:
917 title: 查询条件 - 关键字(模糊，帐号、姓名等)
918 type: string
919 accountName:
920 title: 查询条件 - 账户名(模糊)
921 type: string
922 name:
923 title: 查询条件 - 姓名(模糊)
924 type: string
925 responses:
926 '200':
927 description: 用户分页列表
928 content:
929 application/json:
930 schema:
931 $ref: '#/components/schemas/UserInfoPageResponse'
932 default:
933 $ref: '#/components/responses/DefaultErrorResponse'
934
935 '/organizations/{organizationId}/allSub/users':
936 get:
937 summary: 获取组织机构(及其子集)下的用户列表（弃用）
938 description: 弃用，应该使用 /organizations/users
939 operationId: listUsersByOrganizationAllSub
940 tags:
941 - Organization
942 security:
943 - oauth2:
944 - "user:v1:readOrganization"
945 parameters:
946 - name: organizationId
947 in: path
948 required: true
949 description: 组织机构ID
950 schema:
951 type: string
952 - name: pageIndex
953 in: query
954 required: true
955 description: 分页-页码
956 schema:
957 type: integer
958 format: int32
959 default: 0
960 - name: pageSize
961 in: query
962 required: true
963 description: 分页-每页记录数
964 schema:
965 type: integer
966 format: int32
967 default: 20
968 - name: mapBean
969 in: query
970 required: false
971 description: 查询条件
972 style: deepObject
973 explode: true
974 schema:
975 type: object
976 properties:
977 keyword:
978 title: 查询条件 - 关键字(模糊，帐号、姓名等)
979 type: string
980 accountName:
981 title: 查询条件 - 账户名(模糊)
982 type: string
983 name:
984 title: 查询条件 - 姓名(模糊)
985 type: string
986 responses:
987 '200':
988 description: 用户分页列表
989 content:
990 application/json:
991 schema:
992 $ref: '#/components/schemas/UserInfoPageResponse'
993 default:
994 $ref: '#/components/responses/DefaultErrorResponse'
995
996 '/organizations/users':
997 get:
998 summary: 获取组织机构下的用户列表
999 description: organizationId和organizationCode二选一
1000 operationId: listOrganizationUsers
1001 tags:
1002 - Organization
1003 security:
1004 - oauth2:
1005 - "user:v1:readOrganization"
1006 parameters:
1007 - name: organizationId
1008 in: query
1009 description: 组织机构Id
1010 schema:
1011 type: string
1012 - name: organizationCode
1013 in: query
1014 description: 组织机构Code
1015 schema:
1016 type: string
1017 - name: fetchSub
1018 in: query
1019 description: 是否包含子组织机构的用户
1020 schema:
1021 type: boolean
1022 default: false
1023 - name: pageIndex
1024 in: query
1025 required: true
1026 description: 分页-页码
1027 schema:
1028 type: integer
1029 format: int32
1030 default: 0
1031 - name: pageSize
1032 in: query
1033 required: true
1034 description: 分页-每页记录数
1035 schema:
1036 type: integer
1037 format: int32
1038 default: 20
1039 - name: mapBean
1040 in: query
1041 required: false
1042 description: 查询条件
1043 style: deepObject
1044 explode: true
1045 schema:
1046 type: object
1047 properties:
1048 keyword:
1049 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1050 type: string
1051 accountName:
1052 title: 查询条件 - 账户名(模糊)
1053 type: string
1054 name:
1055 title: 查询条件 - 姓名(模糊)
1056 type: string
1057 responses:
1058 '200':
1059 description: 用户分页列表
1060 content:
1061 application/json:
1062 schema:
1063 $ref: '#/components/schemas/UserInfoPageResponse'
1064 default:
1065 $ref: '#/components/responses/DefaultErrorResponse'
1066
1067 '/organizations/accountId/{accountId}/rootOrganization/{rootOrganizationId}/organizationChain':
1068 get:
1069 summary: 获取帐号在根组织机构下的所属组织机构
1070 operationId: getAccountOrganizationsOfRoot
1071 tags:
1072 - Organization
1073 security:
1074 - oauth2:
1075 - "user:v1:readOrganization"
1076 parameters:
1077 - name: rootOrganizationId
1078 in: path
1079 required: true
1080 description: 根组织机构ID
1081 schema:
1082 type: string
1083 - name: accountId
1084 in: path
1085 required: true
1086 description: 帐号
1087 schema:
1088 type: string
1089 responses:
1090 '200':
1091 description: 组织机构列表
1092 content:
1093 application/json:
1094 schema:
1095 $ref: '#/components/schemas/OrganizationListResponse'
1096 default:
1097 $ref: '#/components/responses/DefaultErrorResponse'
1098
1099
1100 '/groups':
1101 get:
1102 summary: 获取用户组（所有）的列表
1103 operationId: pageGroups
1104 tags:
1105 - Group
1106 security:
1107 - oauth2:
1108 - "user:v1:readGroup"
1109 parameters:
1110 - name: pageIndex
1111 in: query
1112 required: true
1113 description: 分页-页码
1114 schema:
1115 type: integer
1116 format: int32
1117 default: 0
1118 - name: pageSize
1119 in: query
1120 required: true
1121 description: 分页-每页记录数
1122 schema:
1123 type: integer
1124 format: int32
1125 default: 20
1126 - name: mapBean
1127 in: query
1128 required: false
1129 description: 查询条件
1130 style: deepObject
1131 explode: true
1132 schema:
1133 type: object
1134 properties:
1135 ids:
1136 title: 查询条件 - IDs(多个用逗号隔开)
1137 type: string
1138 keyword:
1139 title: 查询条件 - 关键字(模糊，名称、描述等)
1140 type: string
1141 name:
1142 title: 查询条件 - 名称(模糊)
1143 type: string
1144 description:
1145 title: 查询条件 - 描述(模糊)
1146 type: string
1147 type:
1148 title: 查询条件 - 类型(精确，1 普通用户组，2 岗位用户组)
1149 type: string
1150 responses:
1151 '200':
1152 description: 用户组分页列表
1153 content:
1154 application/json:
1155 schema:
1156 $ref: '#/components/schemas/GroupPageResponse'
1157 default:
1158 $ref: '#/components/responses/DefaultErrorResponse'
1159
1160 '/groups/{groupId}':
1161 get:
1162 summary: 根据用户组ID获取用户组（所有）的基本信息
1163 operationId: getGroup
1164 tags:
1165 - Group
1166 security:
1167 - oauth2:
1168 - "user:v1:readGroup"
1169 parameters:
1170 - name: groupId
1171 in: path
1172 required: true
1173 description: 用户组ID
1174 schema:
1175 type: string
1176 responses:
1177 '200':
1178 description: 用户组信息
1179 content:
1180 application/json:
1181 schema:
1182 $ref: '#/components/schemas/GroupLoadResponse'
1183 default:
1184 $ref: '#/components/responses/DefaultErrorResponse'
1185
1186 '/groups/groupCode/{groupCode}':
1187 get:
1188 summary: 根据用户组代码获取用户组（所有）的基本信息
1189 operationId: getGroupByCode
1190 tags:
1191 - Group
1192 security:
1193 - oauth2:
1194 - "user:v1:readGroup"
1195 parameters:
1196 - name: groupCode
1197 in: path
1198 required: true
1199 description: 用户组代码
1200 schema:
1201 type: string
1202 responses:
1203 '200':
1204 description: 用户组信息
1205 content:
1206 application/json:
1207 schema:
1208 $ref: '#/components/schemas/GroupLoadResponse'
1209 default:
1210 $ref: '#/components/responses/DefaultErrorResponse'
1211
1212
1213 '/groups/{groupId}/users':
1214 get:
1215 summary: 获取用户组（所有）下的用户列表（弃用）
1216 description: 弃用，应该使用 /groups/users
1217 operationId: listUsersByGroup
1218 tags:
1219 - Group
1220 security:
1221 - oauth2:
1222 - "user:v1:readGroup"
1223 parameters:
1224 - name: groupId
1225 in: path
1226 required: true
1227 description: 用户组ID
1228 schema:
1229 type: string
1230 - name: pageIndex
1231 in: query
1232 required: true
1233 description: 分页-页码
1234 schema:
1235 type: integer
1236 format: int32
1237 default: 0
1238 - name: pageSize
1239 in: query
1240 required: true
1241 description: 分页-每页记录数
1242 schema:
1243 type: integer
1244 format: int32
1245 default: 20
1246 - name: mapBean
1247 in: query
1248 required: false
1249 description: 查询条件
1250 style: deepObject
1251 explode: true
1252 schema:
1253 type: object
1254 properties:
1255 keyword:
1256 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1257 type: string
1258 accountName:
1259 title: 查询条件 - 账户名(模糊)
1260 type: string
1261 name:
1262 title: 查询条件 - 姓名(模糊)
1263 type: string
1264 responses:
1265 '200':
1266 description: 用户分页列表
1267 content:
1268 application/json:
1269 schema:
1270 $ref: '#/components/schemas/UserInfoPageResponse'
1271 default:
1272 $ref: '#/components/responses/DefaultErrorResponse'
1273
1274 '/groups/users':
1275 get:
1276 summary: 获取用户组（所有）下的用户列表
1277 description: groupId和groupCode二选一
1278 operationId: listGroupUsers
1279 tags:
1280 - Group
1281 security:
1282 - oauth2:
1283 - "user:v1:readGroup"
1284 parameters:
1285 - name: groupId
1286 in: query
1287 description: 用户组ID
1288 schema:
1289 type: string
1290 - name: groupCode
1291 in: query
1292 description: 用户组Code
1293 schema:
1294 type: string
1295 - name: pageIndex
1296 in: query
1297 required: true
1298 description: 分页-页码
1299 schema:
1300 type: integer
1301 format: int32
1302 default: 0
1303 - name: pageSize
1304 in: query
1305 required: true
1306 description: 分页-每页记录数
1307 schema:
1308 type: integer
1309 format: int32
1310 default: 20
1311 - name: mapBean
1312 in: query
1313 required: false
1314 description: 查询条件
1315 style: deepObject
1316 explode: true
1317 schema:
1318 type: object
1319 properties:
1320 keyword:
1321 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1322 type: string
1323 accountName:
1324 title: 查询条件 - 账户名(模糊)
1325 type: string
1326 name:
1327 title: 查询条件 - 姓名(模糊)
1328 type: string
1329 responses:
1330 '200':
1331 description: 用户分页列表
1332 content:
1333 application/json:
1334 schema:
1335 $ref: '#/components/schemas/UserInfoPageResponse'
1336 default:
1337 $ref: '#/components/responses/DefaultErrorResponse'
1338
1339 '/groups/{groupId}/organizationId/{organizationId}/users':
1340 get:
1341 summary: 获取用户组（所有）、部门下的用户列表
1342 operationId: listUsersByGroupOrganization
1343 tags:
1344 - Group
1345 security:
1346 - oauth2:
1347 - "user:v1:readGroup"
1348 parameters:
1349 - name: groupId
1350 in: path
1351 required: true
1352 description: 用户组ID
1353 schema:
1354 type: string
1355 - name: organizationId
1356 in: path
1357 required: true
1358 description: 组织机构ID
1359 schema:
1360 type: string
1361 - name: pageIndex
1362 in: query
1363 required: true
1364 description: 分页-页码
1365 schema:
1366 type: integer
1367 format: int32
1368 default: 0
1369 - name: pageSize
1370 in: query
1371 required: true
1372 description: 分页-每页记录数
1373 schema:
1374 type: integer
1375 format: int32
1376 default: 20
1377 - name: mapBean
1378 in: query
1379 required: false
1380 description: 查询条件
1381 style: deepObject
1382 explode: true
1383 schema:
1384 type: object
1385 properties:
1386 keyword:
1387 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1388 type: string
1389 accountName:
1390 title: 查询条件 - 账户名(模糊)
1391 type: string
1392 name:
1393 title: 查询条件 - 姓名(模糊)
1394 type: string
1395 responses:
1396 '200':
1397 description: 用户分页列表
1398 content:
1399 application/json:
1400 schema:
1401 $ref: '#/components/schemas/UserInfoPageResponse'
1402 default:
1403 $ref: '#/components/responses/DefaultErrorResponse'
1404
1405 '/groups/{groupId}/accountId/{accountId}':
1406 get:
1407 summary: 获取用户组（普通）下指定帐号的关系
1408 operationId: loadAccountGroup
1409 tags:
1410 - Group
1411 security:
1412 - oauth2:
1413 - "user:v1:readGroup"
1414 parameters:
1415 - name: groupId
1416 in: path
1417 required: true
1418 description: 用户组ID
1419 schema:
1420 type: string
1421 - name: accountId
1422 in: path
1423 required: true
1424 description: 帐号
1425 schema:
1426 type: string
1427 responses:
1428 '200':
1429 description: 帐号-用户组
1430 content:
1431 application/json:
1432 schema:
1433 $ref: '#/components/schemas/AccountGroupResponse'
1434 default:
1435 $ref: '#/components/responses/DefaultErrorResponse'
1436
1437 '/groups/accountId/{accountId}/groups':
1438 get:
1439 summary: 获取帐号的用户组（普通）
1440 operationId: listAccountGroups
1441 tags:
1442 - Group
1443 security:
1444 - oauth2:
1445 - "user:v1:readGroup"
1446 parameters:
1447 - name: accountId
1448 in: path
1449 required: true
1450 description: 帐号
1451 schema:
1452 type: string
1453 responses:
1454 '200':
1455 description: 用户组
1456 content:
1457 application/json:
1458 schema:
1459 $ref: '#/components/schemas/GroupListResponse'
1460 default:
1461 $ref: '#/components/responses/DefaultErrorResponse'
1462
1463
1464 '/groups/{groupId}/accountOrganizations':
1465 get:
1466 summary: 获取用户组（岗位）下的帐号 - 组织机构列表
1467 operationId: listAccountOrganizationsByGroup
1468 tags:
1469 - Group
1470 security:
1471 - oauth2:
1472 - "user:v1:readGroup"
1473 parameters:
1474 - name: groupId
1475 in: path
1476 required: true
1477 description: 用户组ID
1478 schema:
1479 type: string
1480 responses:
1481 '200':
1482 description: 岗位-组织机构-帐号关系的列表
1483 content:
1484 application/json:
1485 schema:
1486 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1487 default:
1488 $ref: '#/components/responses/DefaultErrorResponse'
1489
1490 '/groups/accountId/{accountId}/groupOrganizations':
1491 get:
1492 summary: 获取帐号的用户组（岗位） - 组织机构列表
1493 operationId: listGroupOrganizationsByAccount
1494 tags:
1495 - Group
1496 security:
1497 - oauth2:
1498 - "user:v1:readGroup"
1499 parameters:
1500 - name: accountId
1501 in: path
1502 required: true
1503 description: 帐号ID
1504 schema:
1505 type: string
1506 responses:
1507 '200':
1508 description: 岗位-组织机构-帐号关系的列表
1509 content:
1510 application/json:
1511 schema:
1512 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1513 default:
1514 $ref: '#/components/responses/DefaultErrorResponse'
1515
1516 '/groups/organizationId/{organizationId}/accountGroups':
1517 get:
1518 summary: 获取组织机构下的帐号 - 用户组（岗位）列表
1519 operationId: listAccountGroupsByOrganization
1520 tags:
1521 - Group
1522 security:
1523 - oauth2:
1524 - "user:v1:readGroup"
1525 parameters:
1526 - name: organizationId
1527 in: path
1528 required: true
1529 description: 组织机构ID
1530 schema:
1531 type: string
1532 responses:
1533 '200':
1534 description: 岗位-组织机构-帐号关系的列表
1535 content:
1536 application/json:
1537 schema:
1538 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1539 default:
1540 $ref: '#/components/responses/DefaultErrorResponse'
1541
1542 '/groups/{groupId}/accountId/{accountId}/organizations':
1543 get:
1544 summary: 获取用户组（岗位）下指定帐号 的 组织机构
1545 operationId: listOrganizationsByAccountGroup
1546 tags:
1547 - Group
1548 security:
1549 - oauth2:
1550 - "user:v1:readGroup"
1551 parameters:
1552 - name: groupId
1553 in: path
1554 required: true
1555 description: 用户组ID
1556 schema:
1557 type: string
1558 - name: accountId
1559 in: path
1560 required: true
1561 description: 帐号ID
1562 schema:
1563 type: string
1564 responses:
1565 '200':
1566 description: 岗位-组织机构-帐号关系的列表
1567 content:
1568 application/json:
1569 schema:
1570 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1571 default:
1572 $ref: '#/components/responses/DefaultErrorResponse'
1573
1574 '/groups/{groupId}/organizationId/{organizationId}/accounts':
1575 get:
1576 summary: 获取用户组（岗位）下指定组织机构 的 帐号
1577 operationId: listAccountsByGroupOrganization
1578 tags:
1579 - Group
1580 security:
1581 - oauth2:
1582 - "user:v1:readGroup"
1583 parameters:
1584 - name: groupId
1585 in: path
1586 required: true
1587 description: 用户组ID
1588 schema:
1589 type: string
1590 - name: organizationId
1591 in: path
1592 required: true
1593 description: 组织机构ID
1594 schema:
1595 type: string
1596 responses:
1597 '200':
1598 description: 岗位-组织机构-帐号关系的列表
1599 content:
1600 application/json:
1601 schema:
1602 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1603 default:
1604 $ref: '#/components/responses/DefaultErrorResponse'
1605
1606 '/groups/{groupId}/accountId/{accountId}/organizationId/{organizationId}':
1607 get:
1608 summary: 获取用户组（岗位）下指定帐号、组织机构的关系
1609 operationId: loadAccountGroupOrganization
1610 tags:
1611 - Group
1612 security:
1613 - oauth2:
1614 - "user:v1:readGroup"
1615 parameters:
1616 - name: groupId
1617 in: path
1618 required: true
1619 description: 用户组ID
1620 schema:
1621 type: string
1622 - name: accountId
1623 in: path
1624 required: true
1625 description: 帐号ID
1626 schema:
1627 type: string
1628 - name: organizationId
1629 in: path
1630 required: true
1631 description: 组织机构ID
1632 schema:
1633 type: string
1634 responses:
1635 '200':
1636 description: 岗位-组织机构-帐号关系
1637 content:
1638 application/json:
1639 schema:
1640 $ref: '#/components/schemas/GroupOrganizationAccountResponse'
1641 default:
1642 $ref: '#/components/responses/DefaultErrorResponse'
1643
1644
1645 '/labels':
1646 get:
1647 summary: 获取用户标签列表
1648 operationId: pageLabels
1649 tags:
1650 - Label
1651 security:
1652 - oauth2:
1653 - "user:v1:readLabel"
1654 parameters:
1655 - name: pageIndex
1656 in: query
1657 required: true
1658 description: 分页-页码
1659 schema:
1660 type: integer
1661 format: int32
1662 default: 0
1663 - name: pageSize
1664 in: query
1665 required: true
1666 description: 分页-每页记录数
1667 schema:
1668 type: integer
1669 format: int32
1670 default: 20
1671 - name: mapBean
1672 in: query
1673 required: false
1674 description: 查询条件
1675 style: deepObject
1676 explode: true
1677 schema:
1678 type: object
1679 properties:
1680 keyword:
1681 title: 查询条件 - 关键字(模糊，名称、描述等)
1682 type: string
1683 name:
1684 title: 查询条件 - 名称(模糊)
1685 type: string
1686 description:
1687 title: 查询条件 - 描述(模糊)
1688 type: string
1689 responses:
1690 '200':
1691 description: 用户标签分页列表
1692 content:
1693 application/json:
1694 schema:
1695 $ref: '#/components/schemas/LabelPageResponse'
1696 default:
1697 $ref: '#/components/responses/DefaultErrorResponse'
1698
1699 '/labels/{labelId}':
1700 get:
1701 summary: 获取用户标签
1702 operationId: getLabel
1703 tags:
1704 - Label
1705 security:
1706 - oauth2:
1707 - "user:v1:readLabel"
1708 parameters:
1709 - name: labelId
1710 in: path
1711 required: true
1712 description: 用户标签ID
1713 schema:
1714 type: string
1715 responses:
1716 '200':
1717 description: 用户标签信息
1718 content:
1719 application/json:
1720 schema:
1721 $ref: '#/components/schemas/LabelLoadResponse'
1722 default:
1723 $ref: '#/components/responses/DefaultErrorResponse'
1724
1725 '/labels/{labelId}/accountId/{accountId}':
1726 get:
1727 summary: 获取用户标签下指定帐号的关系
1728 operationId: loadAccountLabel
1729 tags:
1730 - Label
1731 security:
1732 - oauth2:
1733 - "user:v1:readLabel"
1734 parameters:
1735 - name: accountId
1736 in: path
1737 required: true
1738 description: 帐号
1739 schema:
1740 type: string
1741 - name: labelId
1742 in: path
1743 required: true
1744 description: 用户标签ID
1745 schema:
1746 type: string
1747 responses:
1748 '200':
1749 description: 用户标签
1750 content:
1751 application/json:
1752 schema:
1753 $ref: '#/components/schemas/AccountLabelResponse'
1754 default:
1755 $ref: '#/components/responses/DefaultErrorResponse'
1756
1757 '/labels/{labelId}/users':
1758 get:
1759 summary: 获取用户标签下的用户列表
1760 operationId: listUsersByLabel
1761 tags:
1762 - Label
1763 security:
1764 - oauth2:
1765 - "user:v1:readLabel"
1766 parameters:
1767 - name: labelId
1768 in: path
1769 required: true
1770 description: 用户标签ID
1771 schema:
1772 type: string
1773 - name: pageIndex
1774 in: query
1775 required: true
1776 description: 分页-页码
1777 schema:
1778 type: integer
1779 format: int32
1780 default: 0
1781 - name: pageSize
1782 in: query
1783 required: true
1784 description: 分页-每页记录数
1785 schema:
1786 type: integer
1787 format: int32
1788 default: 20
1789 - name: mapBean
1790 in: query
1791 required: false
1792 description: 查询条件
1793 style: deepObject
1794 explode: true
1795 schema:
1796 type: object
1797 properties:
1798 keyword:
1799 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1800 type: string
1801 accountName:
1802 title: 查询条件 - 账户名(模糊)
1803 type: string
1804 name:
1805 title: 查询条件 - 姓名(模糊)
1806 type: string
1807 responses:
1808 '200':
1809 description: 用户分页列表
1810 content:
1811 application/json:
1812 schema:
1813 $ref: '#/components/schemas/UserInfoPageResponse'
1814 default:
1815 $ref: '#/components/responses/DefaultErrorResponse'
1816
1817 '/labels/accountId/{accountId}/labels':
1818 get:
1819 summary: 获取帐号的用户标签
1820 operationId: listAccountLabels
1821 tags:
1822 - Label
1823 security:
1824 - oauth2:
1825 - "user:v1:readLabel"
1826 parameters:
1827 - name: accountId
1828 in: path
1829 required: true
1830 description: 帐号
1831 schema:
1832 type: string
1833 responses:
1834 '200':
1835 description: 用户标签
1836 content:
1837 application/json:
1838 schema:
1839 $ref: '#/components/schemas/LabelListResponse'
1840 default:
1841 $ref: '#/components/responses/DefaultErrorResponse'
1842
1843
1844
1845
1846 '/admin/posts/accountName/{accountName}/manOrganizations':
1847 get:
1848 summary: 根据帐号获取可管理的组织机构列表
1849 operationId: loadManOrganizationsByAccount
1850 tags:
1851 - PostAdmin
1852 security:
1853 - oauth2:
1854 - "user:v1:readPost"
1855 parameters:
1856 - name: accountName
1857 in: path
1858 required: true
1859 description: 帐号
1860 schema:
1861 type: string
1862 responses:
1863 '200':
1864 description: 岗位-组织机构-帐号关系的列表
1865 content:
1866 application/json:
1867 schema:
1868 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1869 default:
1870 $ref: '#/components/responses/DefaultErrorResponse'
1871
1872 '/admin/posts/organizationId/{organizationId}/accountName/{accountName}/manPosts':
1873 get:
1874 summary: 根据组织机构Id、帐号获取该帐号在组织机构下的可管理岗位
1875 operationId: loadManPostsByOrganizationOfAccount
1876 tags:
1877 - PostAdmin
1878 security:
1879 - oauth2:
1880 - "user:v1:readPost"
1881 parameters:
1882 - name: organizationId
1883 in: path
1884 required: true
1885 description: 组织机构ID
1886 schema:
1887 type: string
1888 - name: accountName
1889 in: path
1890 required: true
1891 description: 帐号
1892 schema:
1893 type: string
1894 responses:
1895 '200':
1896 description: 岗位-组织机构设置的列表
1897 content:
1898 application/json:
1899 schema:
1900 $ref: '#/components/schemas/GroupOrganizationListResponse'
1901 default:
1902 $ref: '#/components/responses/DefaultErrorResponse'
1903
1904 '/admin/posts/organizationId/{organizationId}/posts':
1905 get:
1906 summary: 根据组织机构Id获取组织机构下的所有岗位
1907 operationId: loadPostsByOrganization
1908 tags:
1909 - PostAdmin
1910 security:
1911 - oauth2:
1912 - "user:v1:readPost"
1913 parameters:
1914 - name: organizationId
1915 in: path
1916 required: true
1917 description: 组织机构ID
1918 schema:
1919 type: string
1920 responses:
1921 '200':
1922 description: 岗位-组织机构设置的列表
1923 content:
1924 application/json:
1925 schema:
1926 $ref: '#/components/schemas/GroupOrganizationListResponse'
1927 default:
1928 $ref: '#/components/responses/DefaultErrorResponse'
1929
1930
1931 '/admin/posts/organizationId/{organizationId}/postAccounts':
1932 get:
1933 summary: 根据组织机构Id获取组织机构下的岗位人员
1934 operationId: listPostAccountsByOrganization
1935 tags:
1936 - PostAdmin
1937 security:
1938 - oauth2:
1939 - "user:v1:readPost"
1940 parameters:
1941 - name: organizationId
1942 in: path
1943 required: true
1944 description: 组织机构ID
1945 schema:
1946 type: string
1947 responses:
1948 '200':
1949 description: 岗位-组织机构-帐号关系的列表
1950 content:
1951 application/json:
1952 schema:
1953 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1954 default:
1955 $ref: '#/components/responses/DefaultErrorResponse'
1956
1957 post:
1958 summary: 根据组织机构Id保存组织机构下的岗位人员
1959 operationId: savePostAccountsByOrganization
1960 tags:
1961 - PostAdmin
1962 security:
1963 - oauth2:
1964 - "user:v1:writePost"
1965 parameters:
1966 - name: organizationId
1967 in: path
1968 required: true
1969 description: 组织机构ID
1970 schema:
1971 type: string
1972 requestBody:
1973 description: 岗位-组织机构-帐号关系的列表
1974 required: true
1975 content:
1976 application/json:
1977 schema:
1978 $ref: '#/components/schemas/GroupOrganizationAccountSaveRequest'
1979 responses:
1980 '200':
1981 description: 保存结果
1982 content:
1983 application/json:
1984 schema:
1985 $ref: '#/components/schemas/GroupOrganizationAccountSaveResponse'
1986 default:
1987 $ref: '#/components/responses/DefaultErrorResponse'
1988
1989 '/admin/posts/organizationId/{organizationId}/group/{groupId}/accounts':
1990 post:
1991 summary: 根据组织机构Id、岗位Id保存人员
1992 operationId: saveAccountsByOrganizationPost
1993 tags:
1994 - PostAdmin
1995 security:
1996 - oauth2:
1997 - "user:v1:writePost"
1998 parameters:
1999 - name: organizationId
2000 in: path
2001 required: true
2002 description: 组织机构ID
2003 schema:
2004 type: string
2005 - name: groupId
2006 in: path
2007 required: true
2008 description: 岗位（用户组）ID
2009 schema:
2010 type: string
2011 requestBody:
2012 description: 岗位-组织机构-帐号关系的列表
2013 required: true
2014 content:
2015 application/json:
2016 schema:
2017 $ref: '#/components/schemas/GroupOrganizationAccountSaveRequest'
2018 responses:
2019 '200':
2020 description: 保存结果
2021 content:
2022 application/json:
2023 schema:
2024 $ref: '#/components/schemas/GroupOrganizationAccountSaveResponse'
2025 default:
2026 $ref: '#/components/responses/DefaultErrorResponse'
2027
2028components:
2029
2030 # Security Schemes
2031
2032 securitySchemes:
2033 oauth2:
2034 type: oauth2
2035 flows:
2036 clientCredentials:
2037 tokenUrl: ${POA_SERVER_URL}/oauth2/token
2038 scopes:
2039 "user:v1:readUser": "读取用户"
2040 "user:v1:readUserSecret": "读取用户私密信息"
2041 "user:v1:readOrganization": "读取组织机构"
2042 "user:v1:readGroup": "读取用户组"
2043 "user:v1:readLabel": "读取用户标签"
2044 "user:v1:readPost": "读取岗位"
2045 "user:v1:writePost": "写入岗位"
2046
2047 responses:
2048 'ErrorResponse400':
2049 description: unexpected error
2050 content:
2051 application/json:
2052 schema:
2053 $ref: '#/components/schemas/ErrorResponse'
2054
2055 DefaultErrorResponse:
2056 description: unexpected error
2057 content:
2058 application/json:
2059 schema:
2060 $ref: '#/components/schemas/ErrorResponse'
2061
2062 schemas:
2063
2064 # Error
2065
2066 ErrorResponse:
2067 title: '异常响应'
2068 required:
2069 - code
2070 - message
2071 properties:
2072 code:
2073 title: 异常代码
2074 type: integer
2075 format: int32
2076 default: -1
2077 message:
2078 title: 异常信息
2079 type: string
2080 default: "未知错误"
2081
2082 # Entity
2083
2084 BaseEntity:
2085 title: 实体 - 基类
2086 type: object
2087 properties:
2088 id:
2089 title: ID
2090 type: string
2091 #companyId:
2092 # title: 'Company ID, 固定 1'
2093 # type: string
2094 # default: '1'
2095 #deleted:
2096 # title: 是否删除
2097 # type: boolean
2098 # default: false
2099 #addAccount:
2100 # title: 创建人
2101 # type: string
2102 #addTime:
2103 # title: 创建时间
2104 # type: string
2105 # format: date-time
2106 #editAccount:
2107 # title: 修改人
2108 # type: string
2109 #editTime:
2110 # title: 修改时间
2111 # type: string
2112 # format: date-time
2113 #deleteAccount:
2114 # title: 删除人
2115 # type: string
2116 #deleteTime:
2117 # title: 删除时间
2118 # type: string
2119 # format: date-time
2120 #isDataCenter:
2121 # title: 是否来源数据中心
2122 # type: boolean
2123 # default: false
2124
2125 DictionaryType:
2126 title: 实体 - 字典
2127 allOf:
2128 - $ref: '#/components/schemas/BaseEntity'
2129 - type: object
2130 title: 实体属性
2131 properties:
2132 code:
2133 title: 代码
2134 type: string
2135 name:
2136 title: 名称
2137 type: string
2138 enable:
2139 title: 是否启用
2140 type: boolean
2141 default: true
2142 sort:
2143 title: 排序
2144 type: integer
2145 format: int64
2146 multiLevel:
2147 title: 是否多层级
2148 type: boolean
2149
2150 Dictionary:
2151 title: 实体 - 字典
2152 allOf:
2153 - $ref: '#/components/schemas/BaseEntity'
2154 - type: object
2155 title: 实体属性
2156 properties:
2157 code:
2158 title: 代码
2159 type: string
2160 name:
2161 title: 名称
2162 type: string
2163 enable:
2164 title: 是否启用
2165 type: boolean
2166 default: true
2167 sort:
2168 title: 排序
2169 type: integer
2170 format: int64
2171 dictionaryType:
2172 title: 字典类型
2173 allOf:
2174 - $ref: '#/components/schemas/DictionaryType'
2175 parentDictionary:
2176 title: 父字典
2177 allOf:
2178 - $ref: '#/components/schemas/Dictionary'
2179
2180 IdentityType:
2181 title: 实体 - 字典
2182 allOf:
2183 - $ref: '#/components/schemas/BaseEntity'
2184 - type: object
2185 title: 实体属性
2186 properties:
2187 code:
2188 title: 代码
2189 type: string
2190 name:
2191 title: 名称
2192 type: string
2193 enable:
2194 title: 是否启用
2195 type: boolean
2196 sort:
2197 title: 排序
2198 type: integer
2199 format: int64
2200 parentIdentityType:
2201 title: 父身份类型
2202 allOf:
2203 - $ref: '#/components/schemas/IdentityType'
2204
2205 User:
2206 title: 实体 - 用户
2207 allOf:
2208 - $ref: '#/components/schemas/BaseEntity'
2209 - type: object
2210 title: 实体属性
2211 properties:
2212 uid:
2213 title: 用户标识
2214 type: string
2215 passWord:
2216 title: 密码
2217 type: string
2218 name:
2219 title: 名称
2220 type: string
2221 fullNameSpelling:
2222 title: 姓名全拼,根据姓名生成
2223 type: string
2224 nameSpelling:
2225 title: 姓名简拼,根据姓名生成
2226 type: string
2227 email:
2228 title: 名称
2229 type: string
2230 phoneNumber:
2231 title: 名称
2232 type: string
2233 imageUrl:
2234 title: 个人照片地址
2235 type: string
2236 certificateType:
2237 title: 证件类型
2238 allOf:
2239 - $ref: '#/components/schemas/Dictionary'
2240 certificateNumber:
2241 title: 证件号码
2242 type: string
2243 gender:
2244 title: 性别
2245 allOf:
2246 - $ref: '#/components/schemas/Dictionary'
2247 nation:
2248 title: 民族
2249 allOf:
2250 - $ref: '#/components/schemas/Dictionary'
2251 country:
2252 title: 国家
2253 allOf:
2254 - $ref: '#/components/schemas/Dictionary'
2255 address:
2256 title: 地址
2257 allOf:
2258 - $ref: '#/components/schemas/Dictionary'
2259
2260 Organization:
2261 title: 实体 - 组织机构
2262 allOf:
2263 - $ref: '#/components/schemas/BaseEntity'
2264 - type: object
2265 title: 实体属性
2266 properties:
2267 code:
2268 title: 代码
2269 type: string
2270 name:
2271 title: 名称
2272 type: string
2273 enable:
2274 title: 是否启用
2275 type: boolean
2276 sort:
2277 title: 排序
2278 type: integer
2279 format: int64
2280 state:
2281 title: 状态
2282 type: integer
2283 format: int32
2284 type:
2285 title: 类型
2286 allOf:
2287 - $ref: '#/components/schemas/Dictionary'
2288 parentOrganization:
2289 title: 所属的父级组织机构
2290 allOf:
2291 - $ref: '#/components/schemas/Organization'
2292
2293 Account:
2294 title: 实体 - 帐号
2295 allOf:
2296 - $ref: '#/components/schemas/BaseEntity'
2297 - type: object
2298 title: 实体属性
2299 properties:
2300 accountName:
2301 title: 帐号
2302 type: string
2303 state:
2304 title: 状态
2305 type: string
2306 activation:
2307 title: 是否激活
2308 type: boolean
2309 accountExpiryDate:
2310 title: 失效时间
2311 type: string
2312 format: date-time
2313 identityType:
2314 title: 身份
2315 allOf:
2316 - $ref: '#/components/schemas/IdentityType'
2317 organization:
2318 title: 组织机构
2319 allOf:
2320 - $ref: '#/components/schemas/Organization'
2321 user:
2322 title: 用户信息
2323 allOf:
2324 - $ref: '#/components/schemas/User'
2325
2326
2327 # Model
2328
2329 UserInfoModel:
2330 title: 用户信息
2331 type: object
2332 properties:
2333 id:
2334 title: 账号Id(弃用，请用accountId)
2335 type: string
2336 accountId:
2337 title: 账号Id
2338 type: string
2339 accountName:
2340 title: 帐号
2341 type: string
2342 identityTypeId:
2343 title: 身份（ID）
2344 type: string
2345 identityTypeCode:
2346 title: 身份（代码）
2347 type: string
2348 identityTypeName:
2349 title: 身份（名称）
2350 type: string
2351 organizationId:
2352 title: 组织机构（ID）
2353 type: string
2354 organizationCode:
2355 title: 组织机构（代码）
2356 type: string
2357 organizationName:
2358 title: 组织机构（名称）
2359 type: string
2360 userId:
2361 title: 用户Id
2362 type: string
2363 uid:
2364 title: 用户号（弃用，应该userNo）
2365 type: string
2366 userNo:
2367 title: 用户号
2368 type: string
2369 name:
2370 title: 姓名
2371 type: string
2372 fullNameSpelling:
2373 title: 姓名全拼,根据姓名生成
2374 type: string
2375 nameSpelling:
2376 title: 姓名简拼,根据姓名生成
2377 type: string
2378 email:
2379 title: 邮箱（注意不是安全邮箱）
2380 type: string
2381 phoneNumber:
2382 title: 手机号（注意不是安全手机）
2383 type: string
2384 imageUrl:
2385 title: 个人照片地址
2386 type: string
2387 certificateTypeId:
2388 title: 证件类型（ID）
2389 type: string
2390 certificateTypeCode:
2391 title: 证件类型（代码）
2392 type: string
2393 certificateTypeName:
2394 title: 证件类型（名称）
2395 type: string
2396 certificateNumber:
2397 title: 证件号码
2398 type: string
2399 genderId:
2400 title: 性别（ID）
2401 type: string
2402 genderCode:
2403 title: 性别（代码）
2404 type: string
2405 genderName:
2406 title: 性别（名称）
2407 type: string
2408 nationId:
2409 title: 民族（ID）
2410 type: string
2411 nationCode:
2412 title: 民族（代码）
2413 type: string
2414 nationName:
2415 title: 民族（名称）
2416 type: string
2417 countryId:
2418 title: 国家（ID）
2419 type: string
2420 countryCode:
2421 title: 国家（代码）
2422 type: string
2423 countryName:
2424 title: 国家（名称）
2425 type: string
2426 addressId:
2427 title: 地址（ID）
2428 type: string
2429 addressCode:
2430 title: 地址（代码）
2431 type: string
2432 addressName:
2433 title: 地址（名称）
2434 type: string
2435
2436 OrganizationModel:
2437 title: 组织机构信息
2438 type: object
2439 properties:
2440 id:
2441 title: ID
2442 type: string
2443 code:
2444 title: 代码
2445 type: string
2446 name:
2447 title: 名称
2448 type: string
2449 description:
2450 title: 描述
2451 type: string
2452 isRootOrganization:
2453 title: 是否根组织机构
2454 type: string
2455 rootOrganizationId:
2456 title: 所在根组织机构（ID）
2457 type: string
2458 parentId:
2459 title: 父级组织机构（ID）
2460 type: string
2461 parentCode:
2462 title: 父级组织机构（代码）
2463 type: string
2464 parentName:
2465 title: 父级组织机构（名称）
2466 type: string
2467 typeId:
2468 title: 类型（ID）
2469 type: string
2470 typeName:
2471 title: 类型（名称）
2472 type: string
2473
2474 GroupModel:
2475 title: 用户组信息
2476 type: object
2477 properties:
2478 id:
2479 title: ID
2480 type: string
2481 code:
2482 title: 代码
2483 type: string
2484 name:
2485 title: 名称
2486 type: string
2487 description:
2488 title: 描述
2489 type: string
2490 type:
2491 title: 类型（1 普通用户组，2 岗位用户组）
2492 type: string
2493
2494 LabelModel:
2495 title: 用户标签信息
2496 type: object
2497 properties:
2498 id:
2499 title: ID
2500 type: string
2501 name:
2502 title: 名称
2503 type: string
2504 description:
2505 title: 描述
2506 type: string
2507
2508 GroupOrganizationModel:
2509 title: 岗位组织机构设置信息
2510 type: object
2511 properties:
2512 id:
2513 title: ID
2514 type: string
2515 groupId:
2516 title: 用户组（岗位）ID
2517 type: string
2518 organizationId:
2519 title: 组织机构ID
2520 type: string
2521
2522 groupCode:
2523 title: 用户组（岗位）代码
2524 type: string
2525 groupName:
2526 title: 用户组（岗位）名称
2527 type: string
2528 groupDescription:
2529 title: 用户组（岗位）描述
2530 type: string
2531 organizationCode:
2532 title: 组织机构代码
2533 type: string
2534 organizationName:
2535 title: 组织机构名称
2536 type: string
2537 organizationDescription:
2538 title: 组织机构描述
2539 type: string
2540
2541 GroupOrganizationAccountModel:
2542 title: 岗位组织机构帐号信息
2543 type: object
2544 properties:
2545 id:
2546 title: ID
2547 type: string
2548 groupId:
2549 title: 用户组（岗位）ID
2550 type: string
2551 organizationId:
2552 title: 组织机构ID
2553 type: string
2554 accountId:
2555 title: 帐号ID
2556 type: string
2557
2558 groupCode:
2559 title: 用户组（岗位）代码
2560 type: string
2561 groupName:
2562 title: 用户组（岗位）名称
2563 type: string
2564 organizationCode:
2565 title: 组织机构代码
2566 type: string
2567 organizationName:
2568 title: 组织机构名称
2569 type: string
2570 accountName:
2571 title: 帐号
2572 type: string
2573 userName:
2574 title: 用户姓名
2575 type: string
2576
2577 accountOrganizationId:
2578 title: 帐号的组织机构ID
2579 type: string
2580 accountOrganizationCode:
2581 title: 帐号的组织机构代码
2582 type: string
2583 accountOrganizationName:
2584 title: 帐号的组织机构名称
2585 type: string
2586
2587
2588 # Request VO
2589 GroupOrganizationAccountSaveRequest:
2590 title: 请求
2591 properties:
2592 groupOrganizatonAccounts:
2593 title: 岗位组织机构帐号信息列表
2594 type: array
2595 items:
2596 $ref: '#/components/schemas/GroupOrganizationAccountModel'
2597
2598
2599 # Response Data
2600
2601
2602 # Response VO
2603
2604 AbstractApiResponse:
2605 title: 响应
2606 properties:
2607 acknowleged:
2608 title: 响应结果
2609 type: boolean
2610 default: true
2611 code:
2612 title: 响应代码
2613 type: integer
2614 format: int32
2615 default: 0
2616 message:
2617 title: 响应信息
2618 type: string
2619 DefaultApiResponse:
2620 allOf:
2621 - $ref: '#/components/schemas/AbstractApiResponse'
2622 - type: object
2623 title: 响应数据
2624 properties:
2625 data:
2626 title: 响应数据
2627 type: object
2628
2629
2630 UserInfoPageResponse:
2631 allOf:
2632 - $ref: '#/components/schemas/DefaultApiResponse'
2633 - type: object
2634 title: 响应数据
2635 properties:
2636 data:
2637 allOf:
2638 - type: object
2639 title: 分页数据
2640 properties:
2641 pageCount:
2642 title: 分页总数
2643 type: integer
2644 format: int32
2645 totalCount:
2646 title: 记录总数
2647 type: integer
2648 format: int64
2649 currentItemCount:
2650 title: 当前返回记录数
2651 type: integer
2652 format: int32
2653 items:
2654 title: 当前返回记录集
2655 type: array
2656 items:
2657 $ref: '#/components/schemas/UserInfoModel'
2658
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]2659 UserTotalCountResponse:
2660 allOf:
2661 - $ref: '#/components/schemas/DefaultApiResponse'
2662 - type: object
2663 title: 响应数据
2664 properties:
2665 data:
2666 allOf:
2667 - type: object
2668 title: 结果
2669 properties:
2670 totalCount:
2671 title: 用户总数
2672 type: integer
2673 format: int32
2674
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2675 UserInfoLoadResponse:
2676 allOf:
2677 - $ref: '#/components/schemas/DefaultApiResponse'
2678 - type: object
2679 title: 响应数据
2680 properties:
2681 data:
2682 allOf:
2683 - $ref: '#/components/schemas/UserInfoModel'
2684
2685 UserInfoListResponse:
2686 allOf:
2687 - $ref: '#/components/schemas/DefaultApiResponse'
2688 - type: object
2689 title: 响应数据
2690 properties:
2691 data:
2692 allOf:
2693 - type: object
2694 title: 列表数据
2695 properties:
2696 items:
2697 title: 当前返回记录集
2698 type: array
2699 items:
2700 $ref: '#/components/schemas/UserInfoModel'
2701
2702 UserPortraitLoadResponse:
2703 allOf:
2704 - $ref: '#/components/schemas/DefaultApiResponse'
2705 - type: object
2706 title: 响应数据
2707 properties:
2708 data:
2709 allOf:
2710 - type: object
2711 title: 列表数据
2712 properties:
2713 portraitBase64:
2714 title: 头像数据（Base64）
2715 type: string
2716 UserSafety:
2717 type: object
2718 title: 安全信息
2719 properties:
2720 userId:
2721 title: 用户Id
2722 type: string
2723 accountId:
2724 title: 账号Id
2725 type: string
2726 accountName:
2727 title: 账号名
2728 type: string
2729 securePhone:
2730 title: 安全手机
2731 type: string
2732 secureEmail:
2733 title: 安全邮箱
2734 type: string
2735
2736 UserSafetyList:
2737 allOf:
2738 - $ref: '#/components/schemas/DefaultApiResponse'
2739 - type: object
2740 title: 响应数据
2741 properties:
2742 data:
2743 allOf:
2744 - type: object
2745 title: 列表数据
2746 properties:
2747 items:
2748 title: 当前返回记录集
2749 type: array
2750 items:
2751 $ref: '#/components/schemas/UserSafety'
2752
2753 UserSafetyPhoneNumber:
2754 type: object
2755 title: 安全手机
2756 properties:
2757 userId:
2758 title: 用户Id
2759 type: string
2760 accountId:
2761 title: 账号Id
2762 type: string
2763 accountName:
2764 title: 账号名
2765 type: string
2766 securePhone:
2767 title: 安全手机
2768 type: string
2769
2770 UserSafetyPhoneNumberList:
2771 allOf:
2772 - $ref: '#/components/schemas/DefaultApiResponse'
2773 - type: object
2774 title: 响应数据
2775 properties:
2776 data:
2777 allOf:
2778 - type: object
2779 title: 列表数据
2780 properties:
2781 items:
2782 title: 当前返回记录集
2783 type: array
2784 items:
2785 $ref: '#/components/schemas/UserSafetyPhoneNumber'
2786
2787 UserSafetyEmail:
2788 type: object
2789 title: 安全邮箱
2790 properties:
2791 userId:
2792 title: 用户Id
2793 type: string
2794 accountId:
2795 title: 账号Id
2796 type: string
2797 accountName:
2798 title: 账号名
2799 type: string
2800 secureEmail:
2801 title: 安全邮箱
2802 type: string
2803
2804 UserSafetyEmailList:
2805 allOf:
2806 - $ref: '#/components/schemas/DefaultApiResponse'
2807 - type: object
2808 title: 响应数据
2809 properties:
2810 data:
2811 allOf:
2812 - type: object
2813 title: 列表数据
2814 properties:
2815 items:
2816 title: 当前返回记录集
2817 type: array
2818 items:
2819 $ref: '#/components/schemas/UserSafetyEmail'
2820
2821 UserSafetyLoadResponse:
2822 allOf:
2823 - $ref: '#/components/schemas/DefaultApiResponse'
2824 - type: object
2825 title: 响应数据
2826 properties:
2827 data:
2828 allOf:
2829 - $ref: '#/components/schemas/UserSafety'
2830
2831 UserFederation:
2832 type: object
2833 title: 联合登录信息
2834 properties:
2835 userId:
2836 title: 用户Id
2837 type: string
2838 accountId:
2839 title: 账号Id
2840 type: string
2841 accountName:
2842 title: 账号名
2843 type: string
2844 federatedType:
2845 title: 联合登录类型
2846 type: string
2847 enum:
2848 - qq
2849 - openweixin
2850 - workweixin
2851 - alipay
2852 - dingtalk
2853 federatedId:
2854 title: 联合登录ID
2855 type: string
2856
2857 UserFederationList:
2858 allOf:
2859 - $ref: '#/components/schemas/DefaultApiResponse'
2860 - type: object
2861 title: 响应数据
2862 properties:
2863 data:
2864 allOf:
2865 - type: object
2866 title: 列表数据
2867 properties:
2868 items:
2869 title: 当前返回记录集
2870 type: array
2871 items:
2872 $ref: '#/components/schemas/UserFederation'
2873
2874 UserFederationLoadResponse:
2875 allOf:
2876 - $ref: '#/components/schemas/DefaultApiResponse'
2877 - type: object
2878 title: 响应数据
2879 properties:
2880 data:
2881 allOf:
2882 - $ref: '#/components/schemas/UserFederation'
2883
2884 RootOrganizationListResponse:
2885 allOf:
2886 - $ref: '#/components/schemas/DefaultApiResponse'
2887 - type: object
2888 title: 响应数据
2889 properties:
2890 data:
2891 allOf:
2892 - type: object
2893 title: 列表数据
2894 properties:
2895 items:
2896 title: 当前返回记录集
2897 type: array
2898 items:
2899 $ref: '#/components/schemas/OrganizationModel'
2900
2901 OrganizationListResponse:
2902 allOf:
2903 - $ref: '#/components/schemas/DefaultApiResponse'
2904 - type: object
2905 title: 响应数据
2906 properties:
2907 data:
2908 allOf:
2909 - type: object
2910 title: 列表数据
2911 properties:
2912 items:
2913 title: 当前返回记录集
2914 type: array
2915 items:
2916 $ref: '#/components/schemas/OrganizationModel'
2917
2918 OrganizationLoadResponse:
2919 allOf:
2920 - $ref: '#/components/schemas/DefaultApiResponse'
2921 - type: object
2922 title: 响应数据
2923 properties:
2924 data:
2925 allOf:
2926 - $ref: '#/components/schemas/OrganizationModel'
2927
2928
2929 GroupPageResponse:
2930 allOf:
2931 - $ref: '#/components/schemas/DefaultApiResponse'
2932 - type: object
2933 title: 响应数据
2934 properties:
2935 data:
2936 allOf:
2937 - type: object
2938 title: 分页数据
2939 properties:
2940 pageCount:
2941 title: 分页总数
2942 type: integer
2943 format: int32
2944 totalCount:
2945 title: 记录总数
2946 type: integer
2947 format: int64
2948 currentItemCount:
2949 title: 当前返回记录数
2950 type: integer
2951 format: int32
2952 items:
2953 title: 当前返回记录集
2954 type: array
2955 items:
2956 $ref: '#/components/schemas/GroupModel'
2957
2958 GroupListResponse:
2959 allOf:
2960 - $ref: '#/components/schemas/DefaultApiResponse'
2961 - type: object
2962 title: 响应数据
2963 properties:
2964 data:
2965 allOf:
2966 - type: object
2967 title: 列表数据
2968 properties:
2969 items:
2970 title: 当前返回记录集
2971 type: array
2972 items:
2973 $ref: '#/components/schemas/GroupModel'
2974
2975 GroupLoadResponse:
2976 allOf:
2977 - $ref: '#/components/schemas/DefaultApiResponse'
2978 - type: object
2979 title: 响应数据
2980 properties:
2981 data:
2982 allOf:
2983 - $ref: '#/components/schemas/GroupModel'
2984
2985 AccountGroupResponse:
2986 allOf:
2987 - $ref: '#/components/schemas/DefaultApiResponse'
2988 - type: object
2989 title: 响应数据
2990 properties:
2991 data:
2992 allOf:
2993 - type: object
2994 title: 列表数据
2995 properties:
2996 accountGroupId:
2997 title: 帐号用户组ID
2998 type: string
2999
3000 GroupOrganizationAccountListResponse:
3001 allOf:
3002 - $ref: '#/components/schemas/DefaultApiResponse'
3003 - type: object
3004 title: 响应数据
3005 properties:
3006 data:
3007 allOf:
3008 - type: object
3009 title: 列表数据
3010 properties:
3011 items:
3012 title: 当前返回记录集
3013 type: array
3014 items:
3015 $ref: '#/components/schemas/GroupOrganizationAccountModel'
3016
3017 GroupOrganizationAccountResponse:
3018 allOf:
3019 - $ref: '#/components/schemas/DefaultApiResponse'
3020 - type: object
3021 title: 响应数据
3022 properties:
3023 data:
3024 allOf:
3025 - type: object
3026 title: 列表数据
3027 properties:
3028 groupOrganizationAccountId:
3029 title: 岗位组织机构帐号的关系ID
3030 type: string
3031
3032 LabelPageResponse:
3033 allOf:
3034 - $ref: '#/components/schemas/DefaultApiResponse'
3035 - type: object
3036 title: 响应数据
3037 properties:
3038 data:
3039 allOf:
3040 - type: object
3041 title: 分页数据
3042 properties:
3043 pageCount:
3044 title: 分页总数
3045 type: integer
3046 format: int32
3047 totalCount:
3048 title: 记录总数
3049 type: integer
3050 format: int64
3051 currentItemCount:
3052 title: 当前返回记录数
3053 type: integer
3054 format: int32
3055 items:
3056 title: 当前返回记录集
3057 type: array
3058 items:
3059 $ref: '#/components/schemas/LabelModel'
3060
3061 LabelListResponse:
3062 allOf:
3063 - $ref: '#/components/schemas/DefaultApiResponse'
3064 - type: object
3065 title: 响应数据
3066 properties:
3067 data:
3068 allOf:
3069 - type: object
3070 title: 列表数据
3071 properties:
3072 items:
3073 title: 当前返回记录集
3074 type: array
3075 items:
3076 $ref: '#/components/schemas/LabelModel'
3077
3078 LabelLoadResponse:
3079 allOf:
3080 - $ref: '#/components/schemas/DefaultApiResponse'
3081 - type: object
3082 title: 响应数据
3083 properties:
3084 data:
3085 allOf:
3086 - $ref: '#/components/schemas/LabelModel'
3087
3088 AccountLabelResponse:
3089 allOf:
3090 - $ref: '#/components/schemas/DefaultApiResponse'
3091 - type: object
3092 title: 响应数据
3093 properties:
3094 data:
3095 allOf:
3096 - type: object
3097 title: 列表数据
3098 properties:
3099 accountLabelId:
3100 title: 帐号标签ID
3101 type: string
3102
3103
3104 GroupOrganizationListResponse:
3105 allOf:
3106 - $ref: '#/components/schemas/DefaultApiResponse'
3107 - type: object
3108 title: 响应数据
3109 properties:
3110 data:
3111 allOf:
3112 - type: object
3113 title: 列表数据
3114 properties:
3115 items:
3116 title: 当前返回记录集
3117 type: array
3118 items:
3119 $ref: '#/components/schemas/GroupOrganizationModel'
3120
3121 GroupOrganizationAccountSaveResponse:
3122 allOf:
3123 - $ref: '#/components/schemas/DefaultApiResponse'
3124 - type: object
3125 title: 响应数据
3126 properties:
3127 data:
3128 allOf:
3129 - type: object
3130 title: 列表数据
3131 properties:
3132 message:
3133 title: 保存结果
3134 type: string