| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440 |
- StringId:
- type: string
- pattern: '^[0-9]+$'
- description: 数据库BIGINT在JSON中的安全十进制字符串表达。
- UtcDateTime:
- type: string
- format: date-time
- pattern: 'Z$'
- example: '2026-07-23T03:00:00.000Z'
- RoleCode:
- type: string
- enum: [USER, ADMIN]
- AllowedModule:
- type: string
- enum: [DOCUMENT_BROWSER, BACKEND_MANAGEMENT, AUDIT_LOG, ORGANIZATION_USER_MANAGEMENT]
- DocumentType:
- type: string
- enum: [MAIN, SUB_PLAN, ATTACHMENT]
- DocumentStatus:
- type: string
- enum: [DRAFT, PUBLISHED, ARCHIVED]
- SecurityLevel:
- type: string
- enum: [PUBLIC, INTERNAL, SECRET, CONFIDENTIAL, TOP_SECRET]
- x-comparison-values:
- PUBLIC: 10
- INTERNAL: 20
- SECRET: 30
- CONFIDENTIAL: 40
- TOP_SECRET: 50
- VisibilityType:
- type: string
- enum: [ALL_AUTHENTICATED, ORGANIZATION, CUSTOM]
- AttachmentType:
- type: string
- enum: [SUPPORT_ACHIEVEMENT, TRAINING_MATERIAL, TYPICAL_CASE]
- SubjectType:
- type: string
- enum: [ORG, USER]
- AllowedAction:
- type: string
- enum:
- - VIEW
- - DOWNLOAD
- - EDIT
- - CONFIG_PERMISSION
- - DELETE
- - BIND_ATTACHMENT
- - UNBIND_ATTACHMENT
- CategoryType:
- type: string
- enum: [SCENE, STYLE, SITUATION, VERSION, OTHER]
- EnabledStatus:
- type: string
- enum: [ENABLED, DISABLED]
- AuditResult:
- type: string
- enum: [SUCCESS, FAILURE]
- AuditAction:
- type: string
- enum:
- - LOGIN
- - LOGOUT
- - VIEW_DOCUMENT
- - DOWNLOAD_DOCUMENT
- - UPLOAD_DOCUMENT
- - BATCH_IMPORT
- - EDIT_DOCUMENT
- - DELETE_DOCUMENT
- - CREATE_CATEGORY
- - EDIT_CATEGORY
- - DELETE_CATEGORY
- - CHANGE_PERMISSION
- - BIND_ATTACHMENT
- - UNBIND_ATTACHMENT
- - RESTORE_DOCUMENT
- - CREATE_ORGANIZATION
- - EDIT_ORGANIZATION
- - DELETE_ORGANIZATION
- - CREATE_USER
- - EDIT_USER
- - DELETE_USER
- - RESET_USER_PASSWORD
- - DOCUMENT_PASSWORD_SET
- - DOCUMENT_PASSWORD_REMOVE
- - CREATE_IP_ENTRY
- - EDIT_IP_ENTRY
- - DELETE_IP_ENTRY
- - ASSIGN_ORG_IP
- AuditTarget:
- type: string
- enum:
- - AUTH
- - CATEGORY
- - DOCUMENT
- - ATTACHMENT
- - PERMISSION
- - ATTACHMENT_BINDING
- - ORGANIZATION
- - USER
- - IP_ENTRY
- PageResult:
- type: object
- required: [items, page, pageSize, total, totalPages]
- properties:
- items:
- type: array
- items: {}
- page:
- type: integer
- minimum: 1
- default: 1
- pageSize:
- type: integer
- minimum: 1
- maximum: 100
- default: 20
- total:
- type: integer
- minimum: 0
- totalPages:
- type: integer
- minimum: 0
- HealthData:
- type: object
- additionalProperties: false
- required: [service, status]
- properties:
- service:
- type: string
- enum: [dms]
- status:
- type: string
- enum: [UP]
- HealthResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/HealthData'
- requestId:
- type: string
- format: uuid
- ErrorResponse:
- type: object
- additionalProperties: false
- required: [code, message, details, requestId]
- properties:
- code:
- type: string
- enum:
- - INVALID_ARGUMENT
- - INVALID_CREDENTIALS
- - TOKEN_INVALID
- - TOKEN_EXPIRED
- - USER_DISABLED
- - AUTH_VERSION_MISMATCH
- - FORBIDDEN
- - SECURITY_LEVEL_FORBIDDEN
- - DOCUMENT_VIEW_FORBIDDEN
- - DOCUMENT_DOWNLOAD_FORBIDDEN
- - RESOURCE_NOT_FOUND
- - FILE_NOT_FOUND
- - UNSUPPORTED_FILE_TYPE
- - PREVIEW_UNAVAILABLE
- - PAYLOAD_TOO_LARGE
- - BATCH_MANIFEST_MISMATCH
- - DATA_VERSION_CONFLICT
- - DOCUMENT_NAME_CONFLICT
- - CATEGORY_IN_USE
- - CATEGORY_NOT_LEAF
- - MAIN_PLAN_HAS_CHILDREN
- - ATTACHMENT_IN_USE
- - ATTACHMENT_HAS_NO_ACL
- - SUB_PLAN_PERMISSION_INHERITED
- - DUPLICATE_PERMISSION_SUBJECT
- - MAIN_PLAN_NOT_FOUND
- - INTERNAL_ERROR
- - DOCUMENT_NOT_DELETED
- - FILE_INTEGRITY_MISMATCH
- - FILE_PATH_INVALID
- - RESTORE_FILE_CHANGED
- - RESTORE_CATEGORY_INVALID
- - RESTORE_PARENT_INVALID
- - RESTORE_PERMISSION_INVALID
- - RESTORE_RELATION_CONFLICT
- - ORGANIZATION_IN_USE
- - USER_SELF_PROTECTION
- - CATEGORY_FLAT_MODE_CONFLICT
- - PREVIEW_CONVERTER_UNAVAILABLE
- - PREVIEW_CONVERSION_TIMEOUT
- - PREVIEW_CONVERSION_FAILED
- message:
- type: string
- details:
- type: object
- nullable: true
- additionalProperties: true
- requestId:
- type: string
- format: uuid
- UserSummary:
- type: object
- additionalProperties: false
- required:
- - id
- - username
- - realName
- - organizationId
- - organizationName
- - roleCode
- - roleId
- - roleName
- - securityLevel
- - status
- - allowedModules
- - authVersion
- - rowVersion
- - lastLoginAt
- - lastLoginIp
- properties:
- id:
- $ref: '#/StringId'
- username:
- type: string
- realName:
- type: string
- organizationId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- organizationName:
- type: string
- nullable: true
- roleCode:
- $ref: '#/RoleCode'
- roleId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- description: 自定义角色ID;ADMIN恒为空。
- roleName:
- type: string
- nullable: true
- description: 自定义角色名称;角色被删除后为null。
- securityLevel:
- $ref: '#/SecurityLevel'
- status:
- $ref: '#/EnabledStatus'
- allowedModules:
- type: array
- uniqueItems: true
- items:
- $ref: '#/AllowedModule'
- authVersion:
- type: integer
- minimum: 0
- rowVersion:
- type: integer
- minimum: 0
- lastLoginAt:
- allOf:
- - $ref: '#/UtcDateTime'
- nullable: true
- lastLoginIp:
- type: string
- nullable: true
- LoginRequest:
- type: object
- additionalProperties: false
- required: [username, password, keepSignedIn]
- properties:
- username:
- type: string
- minLength: 1
- password:
- type: string
- format: password
- minLength: 1
- writeOnly: true
- keepSignedIn:
- type: boolean
- LoginData:
- type: object
- additionalProperties: false
- required: [accessToken, tokenType, expiresIn, user]
- properties:
- accessToken:
- type: string
- tokenType:
- type: string
- enum: [Bearer]
- expiresIn:
- type: integer
- enum: [7200, 604800]
- user:
- $ref: '#/UserSummary'
- LoginResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/LoginData'
- requestId:
- type: string
- format: uuid
- UserResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/UserSummary'
- requestId:
- type: string
- format: uuid
- OrganizationNode:
- type: object
- additionalProperties: false
- required: [id, parentId, orgCode, orgName, orgPath, sortNo, status, rowVersion, children]
- properties:
- id:
- $ref: '#/StringId'
- parentId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- orgCode:
- type: string
- orgName:
- type: string
- orgPath:
- type: string
- sortNo:
- type: integer
- status:
- $ref: '#/EnabledStatus'
- rowVersion:
- type: integer
- minimum: 0
- children:
- type: array
- items:
- $ref: '#/OrganizationNode'
- OrganizationTreeResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- type: array
- items:
- $ref: '#/OrganizationNode'
- requestId:
- type: string
- format: uuid
- UserPage:
- type: object
- additionalProperties: false
- required: [items, page, pageSize, total, totalPages]
- properties:
- items:
- type: array
- items:
- $ref: '#/UserSummary'
- page:
- type: integer
- minimum: 1
- pageSize:
- type: integer
- minimum: 1
- maximum: 100
- total:
- type: integer
- minimum: 0
- totalPages:
- type: integer
- minimum: 0
- UserPageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/UserPage'
- requestId:
- type: string
- format: uuid
- EmptySuccessResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- type: object
- additionalProperties: false
- requestId:
- type: string
- format: uuid
- CategoryNode:
- type: object
- additionalProperties: false
- required:
- - id
- - categoryCode
- - categoryName
- - categoryType
- - parentId
- - categoryPath
- - sortNo
- - documentCount
- - rowVersion
- - children
- properties:
- id:
- $ref: '#/StringId'
- categoryCode:
- type: string
- maxLength: 64
- categoryName:
- type: string
- maxLength: 128
- categoryType:
- $ref: '#/CategoryType'
- parentId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- categoryPath:
- type: string
- maxLength: 1000
- sortNo:
- type: integer
- documentCount:
- type: integer
- minimum: 0
- description: 该分类完整有效子树内所有有效MAIN数量(不按当前用户密级/权限过滤,所有登录用户口径一致)。
- rowVersion:
- type: integer
- minimum: 0
- children:
- type: array
- items:
- $ref: '#/CategoryNode'
- CreateCategoryRequest:
- type: object
- additionalProperties: false
- required: [categoryCode, categoryName, categoryType, parentId, sortNo]
- properties:
- categoryCode:
- type: string
- minLength: 1
- maxLength: 64
- categoryName:
- type: string
- minLength: 1
- maxLength: 128
- categoryType:
- $ref: '#/CategoryType'
- parentId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- sortNo:
- type: integer
- UpdateCategoryRequest:
- type: object
- additionalProperties: false
- required: [categoryName, categoryType, parentId, sortNo, rowVersion]
- properties:
- categoryName:
- type: string
- minLength: 1
- maxLength: 128
- categoryType:
- $ref: '#/CategoryType'
- parentId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- sortNo:
- type: integer
- rowVersion:
- type: integer
- minimum: 0
- CategoryTreeResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- type: array
- items:
- $ref: '#/CategoryNode'
- requestId:
- type: string
- format: uuid
- CategoryResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/CategoryNode'
- requestId:
- type: string
- format: uuid
- DeleteCategoryData:
- type: object
- additionalProperties: false
- required: [id, deleted]
- properties:
- id:
- $ref: '#/StringId'
- deleted:
- type: boolean
- enum: [true]
- DeleteCategoryResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/DeleteCategoryData'
- requestId:
- type: string
- format: uuid
- PermissionSummary:
- type: object
- additionalProperties: false
- required: [organizationCount, userCount, inheritedFromMainPlan]
- properties:
- organizationCount:
- type: integer
- minimum: 0
- userCount:
- type: integer
- minimum: 0
- inheritedFromMainPlan:
- type: boolean
- DocumentSummary:
- type: object
- required:
- - id
- - documentName
- - summary
- - documentType
- - status
- - securityLevel
- - visibilityType
- - visibilitySummary
- - categoryId
- - categoryName
- - categoryPath
- - parentDocumentId
- - rootDocumentId
- - attachmentType
- - fileExtension
- - tags
- - childCount
- - attachmentCount
- - viewCount
- - downloadCount
- - createdByName
- - createdAt
- - updatedAt
- - rowVersion
- - allowedActions
- - hasPassword
- - passwordProtectedActions
- - viewLocked
- properties:
- id:
- $ref: '#/StringId'
- documentName:
- type: string
- summary:
- type: string
- nullable: true
- description:
- type: string
- nullable: true
- description: 详细说明:管理员在"查看"对话框维护,供普通用户阅读;不参与全文检索。
- documentType:
- $ref: '#/DocumentType'
- status:
- $ref: '#/DocumentStatus'
- securityLevel:
- $ref: '#/SecurityLevel'
- visibilityType:
- $ref: '#/VisibilityType'
- visibilitySummary:
- type: string
- categoryId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- categoryName:
- type: string
- nullable: true
- categoryPath:
- type: string
- nullable: true
- parentDocumentId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- rootDocumentId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- attachmentType:
- allOf:
- - $ref: '#/AttachmentType'
- nullable: true
- fileExtension:
- type: string
- tags:
- type: array
- items:
- type: string
- childCount:
- type: integer
- minimum: 0
- attachmentCount:
- type: integer
- minimum: 0
- viewCount:
- type: integer
- minimum: 0
- downloadCount:
- type: integer
- minimum: 0
- createdByName:
- type: string
- nullable: true
- createdAt:
- $ref: '#/UtcDateTime'
- updatedAt:
- $ref: '#/UtcDateTime'
- rowVersion:
- type: integer
- minimum: 0
- allowedActions:
- type: array
- uniqueItems: true
- items:
- $ref: '#/AllowedAction'
- hasPassword:
- type: boolean
- description: 主案是否设置密码锁;仅MAIN可设,其余类型恒false。
- passwordProtectedActions:
- type: array
- uniqueItems: true
- items:
- $ref: '#/DocumentPasswordAction'
- description: 密码锁勾选保护的操作码集合;未设密恒为空数组。
- viewLocked:
- type: boolean
- description: 当前用户查看该文档正文是否需要密码;viewLocked时contentSnippet不返回。
- mountedPlanCount:
- type: integer
- minimum: 0
- description: 仅共享附件响应返回。
- DocumentDetail:
- allOf:
- - $ref: '#/DocumentSummary'
- - type: object
- required:
- - originalFileName
- - mimeType
- - fileSize
- - fileHash
- - permissionSummary
- - viewPasswordVerified
- - contentText
- properties:
- originalFileName:
- type: string
- mimeType:
- type: string
- nullable: true
- fileSize:
- type: integer
- minimum: 0
- fileHash:
- type: string
- pattern: '^[0-9a-fA-F]{64}$'
- permissionSummary:
- $ref: '#/PermissionSummary'
- viewPasswordVerified:
- type: boolean
- description: 查看是否已通过密码验证(未锁定恒true)。
- contentText:
- type: string
- nullable: true
- description: 提取的正文文本;viewLocked且请求头密码未验证通过时为null。
- contentExtractStatus:
- type: string
- enum: [SUCCESS, EMPTY, UNSUPPORTED, FAILED]
- description: 正文提取状态。仅管理员详情响应返回。
- contentExtractError:
- type: string
- nullable: true
- description: 提取失败的脱敏原因(异常类型+首行信息,不含绝对路径)。仅管理员详情响应返回;非FAILED时为null。
- contentExtractedAt:
- type: string
- format: date-time
- nullable: true
- description: 最近一次正文提取时间(UTC)。仅管理员详情响应返回。
- AttachmentBindingSummary:
- allOf:
- - $ref: '#/DocumentSummary'
- - type: object
- required: [bindingId, bindingSortNo, mountedPlanCount]
- properties:
- bindingId:
- $ref: '#/StringId'
- bindingSortNo:
- type: integer
- mountedPlanCount:
- type: integer
- minimum: 0
- DocumentPage:
- type: object
- additionalProperties: false
- required: [items, page, pageSize, total, totalPages]
- properties:
- items:
- type: array
- items:
- $ref: '#/DocumentSummary'
- page:
- type: integer
- minimum: 1
- pageSize:
- type: integer
- minimum: 1
- maximum: 100
- total:
- type: integer
- minimum: 0
- totalPages:
- type: integer
- minimum: 0
- AttachmentBindingPage:
- type: object
- additionalProperties: false
- required: [items, page, pageSize, total, totalPages]
- properties:
- items:
- type: array
- items:
- $ref: '#/AttachmentBindingSummary'
- page:
- type: integer
- minimum: 1
- pageSize:
- type: integer
- minimum: 1
- maximum: 100
- total:
- type: integer
- minimum: 0
- totalPages:
- type: integer
- minimum: 0
- MainPlanBrief:
- type: object
- additionalProperties: false
- required: [id, documentName, categoryName, securityLevel]
- properties:
- id:
- $ref: '#/StringId'
- documentName:
- type: string
- categoryName:
- type: string
- nullable: true
- securityLevel:
- $ref: '#/SecurityLevel'
- MainPlanBriefCollection:
- type: object
- additionalProperties: false
- required: [items, total]
- properties:
- items:
- type: array
- items:
- $ref: '#/MainPlanBrief'
- total:
- type: integer
- minimum: 0
- DocumentPageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/DocumentPage'
- requestId:
- type: string
- format: uuid
- DocumentDetailResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/DocumentDetail'
- requestId:
- type: string
- format: uuid
- AttachmentBindingPageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/AttachmentBindingPage'
- requestId:
- type: string
- format: uuid
- MainPlanBriefCollectionResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/MainPlanBriefCollection'
- requestId:
- type: string
- format: uuid
- MainDocumentCreateMetadata:
- type: object
- additionalProperties: false
- required: [documentName, documentType, summary, categoryId, securityLevel, tags]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- documentType: {type: string, enum: [MAIN]}
- summary: {type: string, nullable: true}
- categoryId: {$ref: '#/StringId'}
- securityLevel: {$ref: '#/SecurityLevel'}
- overwriteDocumentId:
- allOf: [{$ref: '#/StringId'}]
- description: 仅在用户确认覆盖同名主案后提交,并必须与rowVersion同时出现。
- rowVersion:
- type: integer
- minimum: 0
- description: 被覆盖文档的当前版本;仅与overwriteDocumentId同时提交。
- tags:
- type: array
- maxItems: 50
- items: {type: string, minLength: 1, maxLength: 64}
- password:
- type: string
- minLength: 1
- maxLength: 128
- description: 可选;仅新增MAIN时允许,与protectedActions必须同时出现;覆盖上传(overwriteDocumentId)时禁止携带。
- protectedActions:
- type: array
- uniqueItems: true
- items: {$ref: '#/DocumentPasswordAction'}
- description: 可选;密码保护的操作码集合,与password必须同时出现。
- SubPlanCreateMetadata:
- type: object
- additionalProperties: false
- required: [documentName, documentType, summary, parentDocumentId, securityLevel, tags]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- documentType: {type: string, enum: [SUB_PLAN]}
- summary: {type: string, nullable: true}
- parentDocumentId: {$ref: '#/StringId'}
- securityLevel: {$ref: '#/SecurityLevel'}
- overwriteDocumentId:
- allOf: [{$ref: '#/StringId'}]
- description: 仅在用户确认覆盖同一主案下同名子案后提交,并必须与rowVersion同时出现。
- rowVersion:
- type: integer
- minimum: 0
- description: 被覆盖文档的当前版本;仅与overwriteDocumentId同时提交。
- tags:
- type: array
- maxItems: 50
- items: {type: string, minLength: 1, maxLength: 64}
- DocumentCreateMetadata:
- oneOf:
- - $ref: '#/MainDocumentCreateMetadata'
- - $ref: '#/SubPlanCreateMetadata'
- discriminator:
- propertyName: documentType
- AttachmentCreateMetadata:
- type: object
- additionalProperties: false
- required: [documentName, attachmentType, summary, tags]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- attachmentType: {$ref: '#/AttachmentType'}
- summary: {type: string, nullable: true}
- tags:
- type: array
- maxItems: 50
- items: {type: string, minLength: 1, maxLength: 64}
- MainDocumentUpdateRequest:
- type: object
- additionalProperties: false
- required: [documentName, summary, categoryId, securityLevel, tags, rowVersion]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- summary: {type: string, nullable: true}
- categoryId: {$ref: '#/StringId'}
- securityLevel: {$ref: '#/SecurityLevel'}
- tags:
- type: array
- maxItems: 50
- items: {type: string, minLength: 1, maxLength: 64}
- rowVersion: {type: integer, minimum: 0}
- organizationId:
- allOf:
- - $ref: '#/StringId'
- description: 目标归属部门;缺省沿用现有归属,调整到其他部门仅ADMIN。
- SubPlanUpdateRequest:
- type: object
- additionalProperties: false
- required: [documentName, summary, securityLevel, tags, rowVersion]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- summary: {type: string, nullable: true}
- securityLevel: {$ref: '#/SecurityLevel'}
- tags:
- type: array
- maxItems: 50
- items: {type: string, minLength: 1, maxLength: 64}
- rowVersion: {type: integer, minimum: 0}
- organizationId:
- allOf:
- - $ref: '#/StringId'
- description: 目标归属部门;缺省沿用现有归属,调整到其他部门仅ADMIN。
- UpdateDocumentRequest:
- oneOf:
- - $ref: '#/MainDocumentUpdateRequest'
- - $ref: '#/SubPlanUpdateRequest'
- UpdateDocumentDescriptionRequest:
- type: object
- additionalProperties: false
- required: [description]
- properties:
- description: {type: string, nullable: true, maxLength: 20000}
- DocumentPasswordAction:
- type: string
- description: 主案密码锁可保护的操作码(与权限矩阵7操作对齐)。
- enum:
- - VIEW
- - DOWNLOAD
- - EDIT
- - DELETE
- - CONFIG_PERMISSION
- - BIND_ATTACHMENT
- - UNBIND_ATTACHMENT
- UpdateDocumentPasswordRequest:
- type: object
- additionalProperties: false
- required: [rowVersion]
- properties:
- rowVersion: {type: integer, minimum: 0, description: 主案当前版本,乐观锁。}
- oldPassword:
- type: string
- maxLength: 128
- description: 已设密时修改/清除必须提供且正确;未设密时禁止提供。
- password:
- type: string
- minLength: 1
- maxLength: 128
- description: 新密码;缺省或空表示清除密码锁,此时不得携带protectedActions。
- protectedActions:
- type: array
- uniqueItems: true
- items: {$ref: '#/DocumentPasswordAction'}
- description: 设置/修改密码时的保护操作集合;与password必须同时出现。
- DocumentPasswordSummary:
- type: object
- additionalProperties: false
- required: [id, hasPassword, protectedActions, rowVersion]
- properties:
- id: {$ref: '#/StringId'}
- hasPassword: {type: boolean}
- protectedActions:
- type: array
- uniqueItems: true
- items: {$ref: '#/DocumentPasswordAction'}
- rowVersion: {type: integer, minimum: 0}
- DocumentPasswordResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code:
- type: string
- enum: [OK]
- message:
- type: string
- enum: [success]
- data:
- $ref: '#/DocumentPasswordSummary'
- requestId:
- type: string
- format: uuid
- UpdateAttachmentRequest:
- type: object
- additionalProperties: false
- required: [documentName, attachmentType, summary, tags, rowVersion]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- attachmentType: {$ref: '#/AttachmentType'}
- summary: {type: string, nullable: true}
- tags:
- type: array
- maxItems: 50
- items: {type: string, minLength: 1, maxLength: 64}
- rowVersion: {type: integer, minimum: 0}
- organizationId:
- allOf:
- - $ref: '#/StringId'
- description: 目标归属部门;缺省沿用现有归属,调整到其他部门仅ADMIN。
- DeleteDocumentData:
- type: object
- additionalProperties: false
- required: [id, deleted]
- properties:
- id: {$ref: '#/StringId'}
- deleted: {type: boolean, enum: [true]}
- DeleteDocumentResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DeleteDocumentData'}
- requestId: {type: string, format: uuid}
- BatchImportMultipart:
- type: object
- additionalProperties: false
- required: [files, items]
- properties:
- files:
- type: array
- minItems: 1
- items: {type: string, format: binary}
- description: 重复files字段,顺序与items数组严格对应。
- items:
- type: string
- description: 文档或附件metadata对象数组的JSON字符串。
- BatchImportItem:
- type: object
- additionalProperties: false
- required: [index, originalFileName, success]
- properties:
- index: {type: integer, minimum: 0}
- originalFileName: {type: string}
- success: {type: boolean}
- document: {$ref: '#/DocumentDetail'}
- errorCode: {type: string}
- errorMessage: {type: string}
- BatchImportData:
- type: object
- additionalProperties: false
- required: [total, successCount, failureCount, items]
- properties:
- total: {type: integer, minimum: 0}
- successCount: {type: integer, minimum: 0}
- failureCount: {type: integer, minimum: 0}
- items:
- type: array
- items: {$ref: '#/BatchImportItem'}
- BatchImportResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BatchImportData'}
- requestId: {type: string, format: uuid}
- BindAttachmentsRequest:
- type: object
- additionalProperties: false
- required: [attachmentIds, mainPlanRowVersion]
- properties:
- attachmentIds:
- type: array
- minItems: 1
- items: {$ref: '#/StringId'}
- mainPlanRowVersion:
- type: integer
- minimum: 0
- BindAttachmentsData:
- type: object
- additionalProperties: false
- required: [createdCount, existingCount, attachmentCount, mainPlanRowVersion]
- properties:
- createdCount: {type: integer, minimum: 0}
- existingCount: {type: integer, minimum: 0}
- attachmentCount: {type: integer, minimum: 0}
- mainPlanRowVersion: {type: integer, minimum: 0}
- BindAttachmentsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BindAttachmentsData'}
- requestId: {type: string, format: uuid}
- UnbindAttachmentData:
- type: object
- additionalProperties: false
- required: [attachmentCount, mainPlanRowVersion]
- properties:
- attachmentCount: {type: integer, minimum: 0}
- mainPlanRowVersion: {type: integer, minimum: 0}
- UnbindAttachmentResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/UnbindAttachmentData'}
- requestId: {type: string, format: uuid}
- ReorderDocumentsRequest:
- type: object
- additionalProperties: false
- required: [orderedIds]
- properties:
- orderedIds:
- type: array
- minItems: 2
- items: {$ref: '#/StringId'}
- ReorderDocumentsData:
- type: object
- additionalProperties: false
- required: [reorderedCount]
- properties:
- reorderedCount: {type: integer, minimum: 0}
- ReorderDocumentsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/ReorderDocumentsData'}
- requestId: {type: string, format: uuid}
- ReorderAttachmentsRequest:
- type: object
- additionalProperties: false
- required: [orderedBindingIds, mainPlanRowVersion]
- properties:
- orderedBindingIds:
- type: array
- minItems: 2
- items: {$ref: '#/StringId'}
- mainPlanRowVersion:
- type: integer
- minimum: 0
- ReorderAttachmentsData:
- type: object
- additionalProperties: false
- required: [reorderedCount, mainPlanRowVersion]
- properties:
- reorderedCount: {type: integer, minimum: 0}
- mainPlanRowVersion: {type: integer, minimum: 0}
- ReorderAttachmentsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/ReorderAttachmentsData'}
- requestId: {type: string, format: uuid}
- ReorderCategoriesRequest:
- type: object
- additionalProperties: false
- required: [parentId, orderedIds]
- properties:
- parentId:
- oneOf:
- - $ref: '#/StringId'
- - type: 'null'
- orderedIds:
- type: array
- minItems: 2
- items: {$ref: '#/StringId'}
- ReorderCategoriesData:
- type: object
- additionalProperties: false
- required: [reorderedCount]
- properties:
- reorderedCount: {type: integer, minimum: 0}
- ReorderCategoriesResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/ReorderCategoriesData'}
- requestId: {type: string, format: uuid}
- PermissionEntry:
- type: object
- additionalProperties: false
- required:
- - id
- - subjectType
- - subjectId
- - subjectName
- - canView
- - canDownload
- - canEdit
- - canManagePermission
- - canDelete
- properties:
- id: {$ref: '#/StringId'}
- subjectType: {$ref: '#/SubjectType'}
- subjectId: {$ref: '#/StringId'}
- subjectName: {type: string}
- canView: {type: boolean}
- canDownload: {type: boolean}
- canEdit: {type: boolean}
- canManagePermission: {type: boolean}
- canDelete: {type: boolean}
- SavePermissionEntry:
- type: object
- additionalProperties: false
- required:
- - subjectType
- - subjectId
- - canView
- - canDownload
- - canEdit
- - canManagePermission
- - canDelete
- properties:
- subjectType: {$ref: '#/SubjectType'}
- subjectId: {$ref: '#/StringId'}
- canView: {type: boolean}
- canDownload: {type: boolean}
- canEdit: {type: boolean}
- canManagePermission: {type: boolean}
- canDelete: {type: boolean}
- SavePermissionsRequest:
- type: object
- additionalProperties: false
- required: [visibilityType, documentRowVersion, entries]
- properties:
- visibilityType: {$ref: '#/VisibilityType'}
- documentRowVersion: {type: integer, minimum: 0}
- entries:
- type: array
- items: {$ref: '#/SavePermissionEntry'}
- description: ALL_AUTHENTICATED必须为空;ORGANIZATION至少一个ORG;CUSTOM可为空。
- PermissionDetail:
- type: object
- additionalProperties: false
- required:
- - documentId
- - sourceDocumentId
- - inherited
- - visibilityType
- - documentRowVersion
- - entries
- properties:
- documentId: {$ref: '#/StringId'}
- sourceDocumentId: {$ref: '#/StringId'}
- inherited: {type: boolean}
- visibilityType: {$ref: '#/VisibilityType'}
- documentRowVersion: {type: integer, minimum: 0}
- entries:
- type: array
- items: {$ref: '#/PermissionEntry'}
- PermissionDetailResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/PermissionDetail'}
- requestId: {type: string, format: uuid}
- AuditGranularity:
- type: string
- enum: [DAY, WEEK, MONTH]
- AuditLogSummary:
- type: object
- additionalProperties: false
- required:
- - id
- - username
- - realName
- - organizationName
- - actionType
- - targetType
- - targetId
- - targetName
- - operationResult
- - failureReason
- - clientIp
- - requestId
- - createdAt
- properties:
- id: {$ref: '#/StringId'}
- username: {type: string, nullable: true}
- realName: {type: string, nullable: true}
- organizationName: {type: string, nullable: true}
- actionType: {$ref: '#/AuditAction'}
- targetType:
- allOf: [{$ref: '#/AuditTarget'}]
- nullable: true
- targetId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- targetName: {type: string, nullable: true}
- operationResult: {$ref: '#/AuditResult'}
- failureReason: {type: string, nullable: true}
- clientIp: {type: string, nullable: true}
- requestId: {type: string, nullable: true}
- createdAt: {$ref: '#/UtcDateTime'}
- AuditLogPage:
- type: object
- additionalProperties: false
- required: [items, page, pageSize, total, totalPages]
- properties:
- items: {type: array, items: {$ref: '#/AuditLogSummary'}}
- page: {type: integer, minimum: 1}
- pageSize: {type: integer, minimum: 1, maximum: 100}
- total: {type: integer, minimum: 0}
- totalPages: {type: integer, minimum: 0}
- AuditLogPageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/AuditLogPage'}
- requestId: {type: string, format: uuid}
- DocumentStatistics:
- type: object
- additionalProperties: false
- required: [planDocumentCount, mainPlanCount, subPlanCount, attachmentCount, todayViewerCount]
- properties:
- planDocumentCount: {type: integer, minimum: 0}
- mainPlanCount: {type: integer, minimum: 0}
- subPlanCount: {type: integer, minimum: 0}
- attachmentCount: {type: integer, minimum: 0}
- todayViewerCount: {type: integer, minimum: 0}
- DocumentStatisticsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DocumentStatistics'}
- requestId: {type: string, format: uuid}
- AuditTrendItem:
- type: object
- additionalProperties: false
- required: [period, operationCount]
- properties:
- period: {type: string}
- operationCount: {type: integer, minimum: 0}
- AuditTrendData:
- type: object
- additionalProperties: false
- required: [items]
- properties:
- items: {type: array, items: {$ref: '#/AuditTrendItem'}}
- AuditTrendResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/AuditTrendData'}
- requestId: {type: string, format: uuid}
- AuditActionStatisticsItem:
- type: object
- additionalProperties: false
- required: [actionType, count]
- properties:
- actionType: {$ref: '#/AuditAction'}
- count: {type: integer, minimum: 0}
- AuditActionStatisticsData:
- type: object
- additionalProperties: false
- required: [items]
- properties:
- items: {type: array, items: {$ref: '#/AuditActionStatisticsItem'}}
- AuditActionStatisticsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/AuditActionStatisticsData'}
- requestId: {type: string, format: uuid}
- AuditUserStatisticsItem:
- type: object
- additionalProperties: false
- required: [userId, realName, organizationName, operationCount]
- properties:
- userId: {$ref: '#/StringId'}
- realName: {type: string, nullable: true}
- organizationName: {type: string, nullable: true}
- operationCount: {type: integer, minimum: 0}
- AuditUserStatisticsData:
- type: object
- additionalProperties: false
- required: [items]
- properties:
- items: {type: array, items: {$ref: '#/AuditUserStatisticsItem'}}
- AuditUserStatisticsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/AuditUserStatisticsData'}
- requestId: {type: string, format: uuid}
- DeletedBySnapshot:
- type: object
- additionalProperties: false
- required: [userId, username, realName, organizationName]
- properties:
- userId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- username: {type: string, nullable: true}
- realName: {type: string, nullable: true}
- organizationName: {type: string, nullable: true}
- RecycleBinDocumentSummary:
- type: object
- additionalProperties: false
- required:
- - id
- - documentName
- - documentType
- - originalFileName
- - categoryId
- - categoryName
- - parentDocumentId
- - securityLevel
- - documentStatus
- - deletedAt
- - updatedBy
- - updatedByName
- - deletedBy
- - rowVersion
- properties:
- id: {$ref: '#/StringId'}
- documentName: {type: string}
- documentType: {$ref: '#/DocumentType'}
- originalFileName: {type: string}
- categoryId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- categoryName: {type: string, nullable: true}
- parentDocumentId:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- securityLevel: {$ref: '#/SecurityLevel'}
- documentStatus: {$ref: '#/DocumentStatus'}
- deletedAt: {$ref: '#/UtcDateTime'}
- updatedBy:
- allOf:
- - $ref: '#/StringId'
- nullable: true
- updatedByName: {type: string, nullable: true}
- deletedBy:
- allOf:
- - $ref: '#/DeletedBySnapshot'
- nullable: true
- rowVersion: {type: integer, minimum: 0}
- RecycleBinDocumentPage:
- type: object
- additionalProperties: false
- required: [items, page, pageSize, total, totalPages]
- properties:
- items:
- type: array
- items: {$ref: '#/RecycleBinDocumentSummary'}
- page: {type: integer, minimum: 1}
- pageSize: {type: integer, minimum: 1, maximum: 100}
- total: {type: integer, minimum: 0}
- totalPages: {type: integer, minimum: 0}
- RecycleBinDocumentPageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/RecycleBinDocumentPage'}
- requestId: {type: string, format: uuid}
- RestoreDocumentRequest:
- type: object
- additionalProperties: false
- required: [rowVersion]
- properties:
- rowVersion: {type: integer, minimum: 0}
- RestoredDocument:
- allOf:
- - $ref: '#/DocumentSummary'
- - type: object
- required: [originalFileName, mimeType, fileSize, permissionSummary]
- properties:
- originalFileName: {type: string}
- mimeType: {type: string, nullable: true}
- fileSize: {type: integer, minimum: 0}
- permissionSummary: {$ref: '#/PermissionSummary'}
- mountedPlanCount: {type: integer, minimum: 0}
- RestoreDocumentResult:
- type: object
- additionalProperties: false
- required:
- - document
- - restoredPermissionCount
- - skippedPermissionCount
- - restoredBindingCount
- - skippedBindingCount
- properties:
- document: {$ref: '#/RestoredDocument'}
- restoredPermissionCount: {type: integer, minimum: 0}
- skippedPermissionCount: {type: integer, minimum: 0}
- restoredBindingCount: {type: integer, minimum: 0}
- skippedBindingCount: {type: integer, minimum: 0}
- RestoreDocumentResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/RestoreDocumentResult'}
- requestId: {type: string, format: uuid}
- DictionaryOption:
- type: object
- additionalProperties: false
- required: [code, label, sortNo]
- properties:
- code: {type: string, minLength: 1}
- label: {type: string, minLength: 1}
- sortNo: {type: integer, minimum: 0}
- DictionaryOptionList:
- type: array
- items: {$ref: '#/DictionaryOption'}
- UiDictionaryGroups:
- type: object
- additionalProperties: false
- required:
- - roleCodes
- - allowedModules
- - documentTypes
- - documentStatuses
- - securityLevels
- - visibilityTypes
- - attachmentTypes
- - subjectTypes
- - deptScopes
- - allowedActions
- - categoryTypes
- - enabledStatuses
- - auditResults
- - auditActions
- - auditTargets
- properties:
- roleCodes: {$ref: '#/DictionaryOptionList'}
- allowedModules: {$ref: '#/DictionaryOptionList'}
- documentTypes: {$ref: '#/DictionaryOptionList'}
- documentStatuses: {$ref: '#/DictionaryOptionList'}
- securityLevels: {$ref: '#/DictionaryOptionList'}
- visibilityTypes: {$ref: '#/DictionaryOptionList'}
- attachmentTypes: {$ref: '#/DictionaryOptionList'}
- subjectTypes: {$ref: '#/DictionaryOptionList'}
- deptScopes: {$ref: '#/DictionaryOptionList'}
- allowedActions: {$ref: '#/DictionaryOptionList'}
- categoryTypes: {$ref: '#/DictionaryOptionList'}
- enabledStatuses: {$ref: '#/DictionaryOptionList'}
- auditResults: {$ref: '#/DictionaryOptionList'}
- auditActions: {$ref: '#/DictionaryOptionList'}
- auditTargets: {$ref: '#/DictionaryOptionList'}
- UiDictionaries:
- type: object
- additionalProperties: false
- required: [version, locale, dictionaries]
- properties:
- version:
- type: string
- pattern: '^[0-9]{4}\.[0-9]+$'
- example: '2026.1'
- locale:
- type: string
- example: zh-CN
- dictionaries: {$ref: '#/UiDictionaryGroups'}
- UiDictionariesResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/UiDictionaries'}
- requestId: {type: string, format: uuid}
- CreateOrganizationRequest:
- type: object
- additionalProperties: false
- required: [orgCode, orgName, parentId, sortNo, status]
- properties:
- orgCode: {type: string, minLength: 1, maxLength: 64}
- orgName: {type: string, minLength: 1, maxLength: 128}
- parentId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- sortNo: {type: integer}
- status: {$ref: '#/EnabledStatus'}
- UpdateOrganizationRequest:
- type: object
- additionalProperties: false
- required: [orgName, parentId, sortNo, status, rowVersion]
- properties:
- orgName: {type: string, minLength: 1, maxLength: 128}
- parentId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- sortNo: {type: integer}
- status: {$ref: '#/EnabledStatus'}
- rowVersion: {type: integer, minimum: 0}
- OrganizationResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data:
- allOf: [{$ref: '#/OrganizationNode'}]
- description: 写操作响应中children固定为空数组。
- requestId: {type: string, format: uuid}
- DeleteOrganizationData:
- type: object
- additionalProperties: false
- required: [id, deleted]
- properties:
- id: {$ref: '#/StringId'}
- deleted: {type: boolean, enum: [true]}
- DeleteOrganizationResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DeleteOrganizationData'}
- requestId: {type: string, format: uuid}
- CreateUserRequest:
- type: object
- additionalProperties: false
- required: [username, realName, initialPassword, organizationId, roleCode, roleId, securityLevel, status]
- properties:
- username: {type: string, minLength: 1, maxLength: 64}
- realName: {type: string, minLength: 1, maxLength: 64}
- initialPassword: {type: string, format: password, minLength: 8, maxLength: 64, writeOnly: true}
- organizationId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- roleCode: {$ref: '#/RoleCode'}
- roleId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- securityLevel: {$ref: '#/SecurityLevel'}
- status: {$ref: '#/EnabledStatus'}
- UpdateUserRequest:
- type: object
- additionalProperties: false
- required: [realName, organizationId, roleCode, roleId, securityLevel, status, rowVersion]
- properties:
- realName: {type: string, minLength: 1, maxLength: 64}
- organizationId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- roleCode: {$ref: '#/RoleCode'}
- roleId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- securityLevel: {$ref: '#/SecurityLevel'}
- status: {$ref: '#/EnabledStatus'}
- rowVersion: {type: integer, minimum: 0}
- DeleteUserData:
- type: object
- additionalProperties: false
- required: [id, deleted]
- properties:
- id: {$ref: '#/StringId'}
- deleted: {type: boolean, enum: [true]}
- DeleteUserResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DeleteUserData'}
- requestId: {type: string, format: uuid}
- ResetUserPasswordRequest:
- type: object
- additionalProperties: false
- required: [newPassword, rowVersion]
- properties:
- newPassword: {type: string, format: password, minLength: 8, maxLength: 64, writeOnly: true}
- rowVersion: {type: integer, minimum: 0}
- ResetPasswordData:
- type: object
- additionalProperties: false
- required: [id, reset, authVersion]
- properties:
- id: {$ref: '#/StringId'}
- reset: {type: boolean, enum: [true]}
- authVersion: {type: integer, minimum: 0}
- ResetPasswordResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/ResetPasswordData'}
- requestId: {type: string, format: uuid}
- DocumentTagCollection:
- type: object
- additionalProperties: false
- required: [items, total]
- properties:
- items:
- type: array
- items: {type: string}
- description: 当前用户可见的主案标签,按Unicode升序。
- total: {type: integer, minimum: 0}
- DocumentTagsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DocumentTagCollection'}
- requestId: {type: string, format: uuid}
- RuntimeConfigData:
- type: object
- additionalProperties: false
- required: [pdfViewerEngine]
- properties:
- pdfViewerEngine:
- type: string
- enum: [iframe, pdfjs]
- description: 后端PDF预览引擎策略,由.env决定。
- RuntimeConfigResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/RuntimeConfigData'}
- requestId: {type: string, format: uuid}
- DeptScope:
- type: string
- description: 权限矩阵部门范围:所属部门方案/其他部门方案(其他部门含所属部门子树外全部部门与无归属文档)。
- enum: [OWN, OTHER]
- RoleSummary:
- type: object
- additionalProperties: false
- required: [id, roleName, sortNo, status, remark, isDefault, memberCount, rowVersion]
- properties:
- id: {$ref: '#/StringId'}
- roleName: {type: string, maxLength: 64}
- sortNo: {type: integer, minimum: 0, maximum: 999999}
- status: {$ref: '#/EnabledStatus'}
- remark:
- type: string
- nullable: true
- maxLength: 255
- isDefault: {type: boolean}
- memberCount: {type: integer, minimum: 0}
- rowVersion: {type: integer, minimum: 0}
- RolePage:
- type: object
- additionalProperties: false
- required: [items, page, pageSize, total, totalPages]
- properties:
- items:
- type: array
- items:
- $ref: '#/RoleSummary'
- page:
- type: integer
- minimum: 1
- pageSize:
- type: integer
- minimum: 1
- maximum: 100
- total:
- type: integer
- minimum: 0
- totalPages:
- type: integer
- minimum: 0
- RolePageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/RolePage'}
- requestId: {type: string, format: uuid}
- CreateRoleRequest:
- type: object
- additionalProperties: false
- required: [roleName, sortNo, status, remark, isDefault]
- properties:
- roleName: {type: string, minLength: 1, maxLength: 64}
- sortNo: {type: integer, minimum: 0, maximum: 999999}
- status: {$ref: '#/EnabledStatus'}
- remark:
- type: string
- nullable: true
- maxLength: 255
- isDefault: {type: boolean}
- UpdateRoleRequest:
- type: object
- additionalProperties: false
- required: [roleName, sortNo, status, remark, isDefault, rowVersion]
- properties:
- roleName: {type: string, minLength: 1, maxLength: 64}
- sortNo: {type: integer, minimum: 0, maximum: 999999}
- status: {$ref: '#/EnabledStatus'}
- remark:
- type: string
- nullable: true
- maxLength: 255
- isDefault: {type: boolean}
- rowVersion: {type: integer, minimum: 0}
- RoleResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/RoleSummary'}
- requestId: {type: string, format: uuid}
- DeleteRoleData:
- type: object
- additionalProperties: false
- required: [id, deleted]
- properties:
- id: {$ref: '#/StringId'}
- deleted: {type: boolean, enum: [true]}
- DeleteRoleResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DeleteRoleData'}
- requestId: {type: string, format: uuid}
- RolePermissionRow:
- type: object
- additionalProperties: false
- required: [securityLevel, deptScope, canView, canDownload, canEdit, canDelete, canConfigPermission, canBindAttachment, canUnbindAttachment]
- properties:
- securityLevel: {$ref: '#/SecurityLevel'}
- deptScope: {$ref: '#/DeptScope'}
- canView: {type: boolean}
- canDownload: {type: boolean}
- canEdit: {type: boolean}
- canDelete: {type: boolean}
- canConfigPermission: {type: boolean}
- canBindAttachment: {type: boolean}
- canUnbindAttachment: {type: boolean}
- RoleMatrixListResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data:
- type: array
- minItems: 15
- maxItems: 15
- items:
- $ref: '#/RolePermissionRow'
- requestId: {type: string, format: uuid}
- UpdateRolePermissionsRequest:
- type: object
- additionalProperties: false
- required: [matrix, rowVersion]
- properties:
- matrix:
- type: array
- minItems: 15
- maxItems: 15
- items:
- $ref: '#/RolePermissionRow'
- rowVersion: {type: integer, minimum: 0}
- RolePermissionsData:
- type: object
- additionalProperties: false
- required: [id, matrix, rowVersion]
- properties:
- id: {$ref: '#/StringId'}
- matrix:
- type: array
- minItems: 15
- maxItems: 15
- items:
- $ref: '#/RolePermissionRow'
- rowVersion: {type: integer, minimum: 0}
- RolePermissionsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/RolePermissionsData'}
- requestId: {type: string, format: uuid}
- RoleUsersData:
- type: object
- additionalProperties: false
- required: [id, userIds]
- properties:
- id: {$ref: '#/StringId'}
- userIds:
- type: array
- items: {$ref: '#/StringId'}
- uniqueItems: true
- rowVersion: {type: integer, minimum: 0}
- RoleUsersResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/RoleUsersData'}
- requestId: {type: string, format: uuid}
- UpdateRoleUsersRequest:
- type: object
- additionalProperties: false
- required: [userIds, rowVersion]
- properties:
- userIds:
- type: array
- items: {$ref: '#/StringId'}
- uniqueItems: true
- rowVersion: {type: integer, minimum: 0}
- DocumentRelationPreset:
- type: object
- additionalProperties: false
- required: [code, label, sortNo]
- properties:
- code: {type: string, minLength: 1, description: 预置类型稳定编码(仅用于前端下拉匹配,不落库)}
- label: {type: string, minLength: 1, description: 预置关系文本(保存时直接写入relation_type)}
- sortNo: {type: integer, minimum: 0}
- DocumentRelationPresetsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data:
- type: object
- additionalProperties: false
- required: [presets]
- properties:
- presets:
- type: array
- items: {$ref: '#/DocumentRelationPreset'}
- requestId: {type: string, format: uuid}
- DocumentRelationItem:
- type: object
- additionalProperties: false
- required: [relatedDocumentId, relatedDocumentName, relationType]
- properties:
- relatedDocumentId: {$ref: '#/StringId'}
- relatedDocumentName: {type: string, minLength: 1}
- relationType: {type: string, minLength: 1, maxLength: 64, description: 关系文本(预置label或用户自定义)}
- DocumentRelationsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data:
- type: object
- additionalProperties: false
- required: [items]
- properties:
- items:
- type: array
- items: {$ref: '#/DocumentRelationItem'}
- requestId: {type: string, format: uuid}
- UpdateDocumentRelationsRequest:
- type: object
- additionalProperties: false
- required: [relations, rowVersion]
- properties:
- relations:
- type: array
- maxItems: 50
- items:
- type: object
- additionalProperties: false
- required: [relatedDocumentId, relationType]
- properties:
- relatedDocumentId: {$ref: '#/StringId'}
- relationType: {type: string, minLength: 1, maxLength: 64}
- uniqueItems: true
- rowVersion: {type: integer, minimum: 0}
- DocumentRelationsSaveResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data:
- type: object
- additionalProperties: false
- required: [relations, rowVersion]
- properties:
- relations:
- type: array
- items: {$ref: '#/DocumentRelationItem'}
- rowVersion: {type: integer, minimum: 0}
- requestId: {type: string, format: uuid}
- IpEntrySummary:
- type: object
- additionalProperties: false
- required: [id, ipValue, remark, rowVersion]
- properties:
- id: {$ref: '#/StringId'}
- ipValue:
- type: string
- minLength: 1
- maxLength: 64
- description: 规范化后的精确IP或CIDR网段文本(IPv6为压缩形式,网段主机位为0)。
- remark:
- type: string
- maxLength: 128
- rowVersion: {type: integer, minimum: 0}
- IpEntryPage:
- type: object
- additionalProperties: false
- required: [items, page, pageSize, total, totalPages]
- properties:
- items:
- type: array
- items:
- $ref: '#/IpEntrySummary'
- page:
- type: integer
- minimum: 1
- pageSize:
- type: integer
- minimum: 1
- maximum: 100
- total:
- type: integer
- minimum: 0
- totalPages:
- type: integer
- minimum: 0
- IpEntryPageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/IpEntryPage'}
- requestId: {type: string, format: uuid}
- CreateIpEntryRequest:
- type: object
- additionalProperties: false
- required: [ipValue, remark]
- properties:
- ipValue: {type: string, minLength: 1, maxLength: 64}
- remark: {type: string, maxLength: 128}
- UpdateIpEntryRequest:
- type: object
- additionalProperties: false
- required: [ipValue, remark, rowVersion]
- properties:
- ipValue: {type: string, minLength: 1, maxLength: 64}
- remark: {type: string, maxLength: 128}
- rowVersion: {type: integer, minimum: 0}
- IpEntryResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/IpEntrySummary'}
- requestId: {type: string, format: uuid}
- DeleteIpEntryData:
- type: object
- additionalProperties: false
- required: [id, deleted]
- properties:
- id: {$ref: '#/StringId'}
- deleted: {type: boolean, enum: [true]}
- DeleteIpEntryResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DeleteIpEntryData'}
- requestId: {type: string, format: uuid}
- OrgIpAssignmentListData:
- type: object
- additionalProperties: false
- required: [ipEntryIds]
- properties:
- ipEntryIds:
- type: array
- items: {$ref: '#/StringId'}
- uniqueItems: true
- OrgIpAssignmentListResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/OrgIpAssignmentListData'}
- requestId: {type: string, format: uuid}
- UpdateOrgIpAssignmentsRequest:
- type: object
- additionalProperties: false
- required: [ipEntryIds, rowVersion]
- properties:
- ipEntryIds:
- type: array
- items: {$ref: '#/StringId'}
- uniqueItems: true
- rowVersion: {type: integer, minimum: 0}
- OrgIpAssignmentsData:
- type: object
- additionalProperties: false
- required: [id, ipEntryIds, rowVersion]
- properties:
- id: {$ref: '#/StringId'}
- ipEntryIds:
- type: array
- items: {$ref: '#/StringId'}
- uniqueItems: true
- rowVersion: {type: integer, minimum: 0}
- OrgIpAssignmentsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/OrgIpAssignmentsData'}
- requestId: {type: string, format: uuid}
|