organizations.yaml 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. OrganizationTree:
  2. get:
  3. operationId: getOrganizationTree
  4. summary: 查询组织树
  5. parameters:
  6. - $ref: '../components/parameters.yaml#/XRequestId'
  7. - name: keyword
  8. in: query
  9. schema:
  10. type: string
  11. - name: status
  12. in: query
  13. schema:
  14. $ref: '../components/schemas.yaml#/EnabledStatus'
  15. responses:
  16. '200':
  17. description: 组织树
  18. content:
  19. application/json:
  20. schema:
  21. $ref: '../components/schemas.yaml#/OrganizationTreeResponse'
  22. '400':
  23. $ref: '../components/responses.yaml#/InvalidArgument'
  24. '401':
  25. $ref: '../components/responses.yaml#/AuthenticationError'
  26. '403':
  27. $ref: '../components/responses.yaml#/Forbidden'
  28. '500':
  29. $ref: '../components/responses.yaml#/InternalError'
  30. Organizations:
  31. post:
  32. operationId: createOrganization
  33. summary: 创建机构
  34. parameters:
  35. - $ref: '../components/parameters.yaml#/XRequestId'
  36. requestBody:
  37. required: true
  38. content:
  39. application/json:
  40. schema:
  41. $ref: '../components/schemas.yaml#/CreateOrganizationRequest'
  42. responses:
  43. '201':
  44. description: 创建成功
  45. content:
  46. application/json:
  47. schema:
  48. $ref: '../components/schemas.yaml#/OrganizationResponse'
  49. '400':
  50. $ref: '../components/responses.yaml#/InvalidArgument'
  51. '401':
  52. $ref: '../components/responses.yaml#/AuthenticationError'
  53. '403':
  54. $ref: '../components/responses.yaml#/Forbidden'
  55. '409':
  56. $ref: '../components/responses.yaml#/Conflict'
  57. '500':
  58. $ref: '../components/responses.yaml#/InternalError'
  59. Organization:
  60. parameters:
  61. - name: id
  62. in: path
  63. required: true
  64. schema:
  65. $ref: '../components/schemas.yaml#/StringId'
  66. put:
  67. operationId: updateOrganization
  68. summary: 编辑机构
  69. requestBody:
  70. required: true
  71. content:
  72. application/json:
  73. schema:
  74. $ref: '../components/schemas.yaml#/UpdateOrganizationRequest'
  75. responses:
  76. '200':
  77. description: 编辑成功
  78. content:
  79. application/json:
  80. schema:
  81. $ref: '../components/schemas.yaml#/OrganizationResponse'
  82. '400':
  83. $ref: '../components/responses.yaml#/InvalidArgument'
  84. '401':
  85. $ref: '../components/responses.yaml#/AuthenticationError'
  86. '403':
  87. $ref: '../components/responses.yaml#/Forbidden'
  88. '404':
  89. $ref: '../components/responses.yaml#/NotFound'
  90. '409':
  91. $ref: '../components/responses.yaml#/Conflict'
  92. '500':
  93. $ref: '../components/responses.yaml#/InternalError'
  94. delete:
  95. operationId: deleteOrganization
  96. summary: 逻辑删除机构
  97. parameters:
  98. - name: rowVersion
  99. in: query
  100. required: true
  101. schema: {type: integer, minimum: 0}
  102. responses:
  103. '200':
  104. description: 删除成功
  105. content:
  106. application/json:
  107. schema:
  108. $ref: '../components/schemas.yaml#/DeleteOrganizationResponse'
  109. '400':
  110. $ref: '../components/responses.yaml#/InvalidArgument'
  111. '401':
  112. $ref: '../components/responses.yaml#/AuthenticationError'
  113. '403':
  114. $ref: '../components/responses.yaml#/Forbidden'
  115. '404':
  116. $ref: '../components/responses.yaml#/NotFound'
  117. '409':
  118. $ref: '../components/responses.yaml#/Conflict'
  119. '500':
  120. $ref: '../components/responses.yaml#/InternalError'
  121. OrganizationIpAssignments:
  122. parameters:
  123. - name: id
  124. in: path
  125. required: true
  126. schema:
  127. $ref: '../components/schemas.yaml#/StringId'
  128. get:
  129. operationId: listOrganizationIpAssignments
  130. summary: 查询部门可登录IP条目ID列表(空列表表示不限制)
  131. parameters:
  132. - $ref: '../components/parameters.yaml#/XRequestId'
  133. responses:
  134. '200':
  135. description: IP条目ID列表
  136. content:
  137. application/json:
  138. schema:
  139. $ref: '../components/schemas.yaml#/OrgIpAssignmentListResponse'
  140. '401':
  141. $ref: '../components/responses.yaml#/AuthenticationError'
  142. '403':
  143. $ref: '../components/responses.yaml#/Forbidden'
  144. '404':
  145. $ref: '../components/responses.yaml#/NotFound'
  146. '500':
  147. $ref: '../components/responses.yaml#/InternalError'
  148. put:
  149. operationId: updateOrganizationIpAssignments
  150. summary: 整存部门可登录IP列表(空数组=清空=不限制)
  151. parameters:
  152. - $ref: '../components/parameters.yaml#/XRequestId'
  153. requestBody:
  154. required: true
  155. content:
  156. application/json:
  157. schema:
  158. $ref: '../components/schemas.yaml#/UpdateOrgIpAssignmentsRequest'
  159. responses:
  160. '200':
  161. description: 保存成功
  162. content:
  163. application/json:
  164. schema:
  165. $ref: '../components/schemas.yaml#/OrgIpAssignmentsResponse'
  166. '400':
  167. $ref: '../components/responses.yaml#/InvalidArgument'
  168. '401':
  169. $ref: '../components/responses.yaml#/AuthenticationError'
  170. '403':
  171. $ref: '../components/responses.yaml#/Forbidden'
  172. '404':
  173. $ref: '../components/responses.yaml#/NotFound'
  174. '409':
  175. $ref: '../components/responses.yaml#/Conflict'
  176. '500':
  177. $ref: '../components/responses.yaml#/InternalError'