| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569 |
- 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
- AttachmentType:
- type: string
- enum: [SUPPORT_ACHIEVEMENT, TRAINING_MATERIAL, TYPICAL_CASE]
- 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
- - UPLOAD_PERMISSION_VOUCHER
- - DELETE_PERMISSION_VOUCHER
- - MOVE_DOCUMENT
- - MOVE_ATTACHMENT
- - 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
- - BACKUP_CREATE
- AuditTarget:
- type: string
- enum:
- - AUTH
- - CATEGORY
- - DOCUMENT
- - ATTACHMENT
- - PERMISSION
- - ATTACHMENT_BINDING
- - ORGANIZATION
- - USER
- - ROLE
- - IP_ENTRY
- - BACKUP
- 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_RELATION_CONFLICT
- - DOCUMENT_NOT_IN_MOVE_SCOPE
- - ORGANIZATION_IN_USE
- - USER_SELF_PROTECTION
- - CATEGORY_FLAT_MODE_CONFLICT
- - PREVIEW_CONVERTER_UNAVAILABLE
- - PREVIEW_CONVERSION_TIMEOUT
- - PREVIEW_CONVERSION_FAILED
- - BACKUP_RUNNING
- - BACKUP_TARGET_UNAVAILABLE
- - BACKUP_TOOL_MISSING
- - BACKUP_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
- - uiTheme
- - permCategoryEdit
- - permOrgEdit
- - permUserEdit
- - permSystemManage
- - permAuditLog
- - permRoleEdit
- - permUpload
- - permAttachmentLibrary
- - permAttachmentUpload
- - managedOrgId
- 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(契约1.46):本人=会话选定角色(JWT roleId claim),列表行=第一挂载角色(按sortNo)。
- roleName:
- type: string
- nullable: true
- description: 展示角色名称(契约1.46):与roleId同口径;角色被删除后为null。
- roles:
- type: array
- description: 全部活跃启用挂载角色简表(契约1.46 多角色);登录选择框与编辑表单回显同口径,可为空数组。
- items:
- type: object
- additionalProperties: false
- required: [id, roleName]
- properties:
- id: {$ref: '#/StringId'}
- roleName: {type: string}
- seatName:
- type: string
- nullable: true
- maxLength: 64
- description: 席位(契约1.46);可空,前端右上角按「机构+空格+席位」展示。
- userType:
- type: string
- enum: [NORMAL, COMMANDER]
- description: 用户类型(契约1.46);NORMAL=普通用户、COMMANDER=首长(仍属USER类别,重置密码方式后续差异化)。
- 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
- uiTheme:
- type: string
- enum: [blue, red, green]
- description: 界面主题偏好(契约1.20,账号级漫游);存量与缺省为blue。
- permCategoryEdit:
- type: boolean
- description: 分类编辑管理位;值取自生效角色(显式角色活跃且启用时优先,否则回退默认角色),内置admin恒为true。
- permOrgEdit:
- type: boolean
- description: 机构编辑管理位;值取自生效角色。
- permUserEdit:
- type: boolean
- description: 用户编辑管理位;值取自生效角色。
- permSystemManage:
- type: boolean
- description: 系统管理管理位(契约1.23);值取自生效角色,内置admin恒为true。
- permAuditLog:
- type: boolean
- description: 日志审计管理位(契约1.23);值取自生效角色,内置admin恒为true。
- permRoleEdit:
- type: boolean
- description: 角色编辑管理位(契约1.25);值取自生效角色,内置admin恒为true。
- permUpload:
- type: boolean
- description: 上传位(契约1.31);生效角色方案权限矩阵任一 OWN 行 canUpload 为 true 即为 true,内置admin恒为true;上传/批量导入接口按此判定。
- permAttachmentLibrary:
- type: boolean
- description: 附件库可见位(契约1.41);生效角色矩阵任一 OWN 行任一附件位为 true,或 ADMIN 类别恒为 true;共享资料库页签门控,接口仍按实时判定。
- permAttachmentUpload:
- type: boolean
- description: 附件上传位(契约1.41);生效角色矩阵任一 OWN 行 canAttachmentUpload 为 true,或 ADMIN 类别恒为 true;共享附件上传/批量导入按钮门控,接口仍按附件密级 OWN 行实时判定。
- managedOrgId:
- type: string
- nullable: true
- description: 用户级管理范围(契约1.30);为机构ID(固定锚点)、"SELF"(跟随该用户所在机构,落库哨兵0)或null(全局),内置admin恒为null。实际生效范围以生效角色锚点为准,角色锚点为"SELF"(跟随用户设置)时才回落本设置。
- LoginRequest:
- type: object
- additionalProperties: false
- required: [username, password, keepSignedIn]
- properties:
- username:
- type: string
- minLength: 1
- description: 登录账号(契约1.47/1.51):接受用户名或姓名——用户名精确匹配优先,未命中按姓名匹配活跃用户且仅唯一命中放行,重名歧义一律401 INVALID_CREDENTIALS;契约1.51起界面以姓名为用户名(新建同值写入两列),本字段语义不变。
- password:
- type: string
- format: password
- minLength: 1
- writeOnly: true
- keepSignedIn:
- type: boolean
- captchaId:
- type: string
- description: 图片验证码标识(安全需求4);DMS_CAPTCHA_ENABLED开启时必填(五键),关闭时不得携带(三键)
- captchaCode:
- type: string
- description: 图片验证码字符(安全需求4,忽略大小写);开关开启时必填
- roleId:
- type: string
- pattern: '^[0-9]+$'
- description: 会话角色选定(契约1.46 多角色,可选数字字符串);首轮返回角色选择步骤后第二轮携带,须指向该用户已挂载的活跃启用角色。
- RoleSelectionData:
- type: object
- additionalProperties: false
- required: [roleSelectionRequired, username, realName, roles]
- description: 多角色选择步骤(契约1.46):挂载多个活跃启用角色且未携带roleId时返回,不签发令牌、不记登录成功;前端选定后携带roleId重新提交登录。
- properties:
- roleSelectionRequired:
- type: boolean
- enum: [true]
- username:
- type: string
- realName:
- type: string
- roles:
- type: array
- minItems: 1
- items:
- type: object
- additionalProperties: false
- required: [id, roleName]
- properties:
- id: {$ref: '#/StringId'}
- roleName: {type: string}
- SetupPasswordPhaseData:
- type: object
- additionalProperties: false
- required: [phase, username, realName, portalTicket, organizations, suggestedOrganizationId]
- description: 本地重设密步骤(契约1.65):密码被重置审批清空(契约1.49)后本地登录不再403,无论输入什么密码(验证码/锁定/IP守卫不受影响)都返回本载荷——与门户验签SET_PASSWORD同构,前端进入与单点登录首次设密同一界面;设密提交统一走 /auth 门户型 setup-password 接口(票据一次性、5分钟有效、authVersion防复用)。organizations语义同门户验签;挂载≥2角色时返回roles逐角色分配密码(契约1.53)。
- properties:
- phase:
- type: string
- enum: [SET_PASSWORD]
- username:
- type: string
- realName:
- type: string
- portalTicket:
- type: string
- suggestedOrganizationId:
- type: string
- nullable: true
- organizations:
- type: array
- items:
- type: object
- additionalProperties: false
- required: [id, orgCode, orgName, orgPath]
- properties:
- id: {type: string}
- orgCode: {type: string}
- orgName: {type: string}
- orgPath: {type: string}
- roles:
- type: array
- description: 仅挂载≥2角色时返回(契约1.53 密码即角色):设密时逐角色分配密码,恰一个使用用户密码
- items:
- type: object
- additionalProperties: false
- required: [id, roleName]
- properties:
- id: {$ref: '#/StringId'}
- roleName: {type: string}
- LoginData:
- type: object
- additionalProperties: false
- required: [accessToken, tokenType, expiresIn, idleLogoutMinutes, tokenRotation, user]
- properties:
- accessToken:
- type: string
- tokenType:
- type: string
- enum: [Bearer]
- expiresIn:
- type: integer
- description: 访问令牌有效期秒数;keepSignedIn=false取环境变量DMS_JWT_EXPIRES_SECONDS(缺省3600),keepSignedIn=true固定604800。
- idleLogoutMinutes:
- type: integer
- minimum: 0
- description: 页面空闲自动登出分钟数(契约1.29);取环境变量DMS_IDLE_LOGOUT_MINUTES(缺省5),0表示关闭。
- tokenRotation:
- type: boolean
- description: 一次一码轮换开关回显(契约1.38,仅Java版实现);取DMS_TOKEN_ROTATION_ENABLED(缺省true),开启时写操作成功响应经X-DMS-Access-Token头返回轮换新授权码。门户设密完成响应同。
- 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:
- oneOf:
- - $ref: '#/LoginData'
- - $ref: '#/RoleSelectionData'
- - $ref: '#/SetupPasswordPhaseData'
- 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: [borrowerCount, inheritedFromMainPlan]
- properties:
- borrowerCount:
- type: integer
- minimum: 0
- description: 生效(canView且未到期)调阅人数
- inheritedFromMainPlan:
- type: boolean
- DocumentSummary:
- type: object
- required:
- - id
- - documentName
- - summary
- - documentType
- - status
- - securityLevel
- - borrowSummary
- - 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'
- borrowSummary:
- type: string
- description: 生效调阅人姓名以"、"连接;未配置时为"未配置";无查看权限的列表行返回"-"
- 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, securityLevel]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- attachmentType: {$ref: '#/AttachmentType'}
- securityLevel: {$ref: '#/SecurityLevel'}
- 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: 主案密码锁可保护的操作码(契约1.41:挂载/解除挂载合并为单一「挂载」位,protectedActions 勾选仅接受前6码——UNBIND_ATTACHMENT 不再是合法勾选码,提交返回 400;该码保留在枚举中是因为解挂接口仍传它做密码校验与审计区分,服务端按挂载位同判定)。
- 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, securityLevel, rowVersion]
- properties:
- documentName: {type: string, minLength: 1, maxLength: 255}
- attachmentType: {$ref: '#/AttachmentType'}
- securityLevel: {$ref: '#/SecurityLevel'}
- 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}
- ReorderOrganizationsRequest:
- type: object
- additionalProperties: false
- required: [parentId, orderedIds]
- properties:
- parentId:
- oneOf:
- - $ref: '#/StringId'
- - type: 'null'
- orderedIds:
- type: array
- minItems: 2
- items: {$ref: '#/StringId'}
- ReorderByIdsRequest:
- type: object
- additionalProperties: false
- required: [orderedIds]
- properties:
- orderedIds:
- type: array
- minItems: 2
- items: {$ref: '#/StringId'}
- ReorderResultData:
- type: object
- additionalProperties: false
- required: [reorderedCount]
- properties:
- reorderedCount: {type: integer, minimum: 0}
- ReorderResultResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/ReorderResultData'}
- requestId: {type: string, format: uuid}
- PermissionEntry:
- type: object
- additionalProperties: false
- required:
- - id
- - subjectId
- - subjectName
- - canView
- - canDownload
- - expiresAt
- - voucherFileName
- - voucherFileSize
- - voucherUploadedAt
- properties:
- id: {$ref: '#/StringId'}
- subjectId: {$ref: '#/StringId'}
- subjectName: {type: string}
- canView: {type: boolean}
- canDownload: {type: boolean}
- expiresAt: {$ref: '#/UtcDateTime'}
- voucherFileName: {type: string, nullable: true}
- voucherFileSize: {type: integer, minimum: 1, nullable: true}
- voucherUploadedAt:
- allOf:
- - $ref: '#/UtcDateTime'
- nullable: true
- SavePermissionEntry:
- type: object
- additionalProperties: false
- required:
- - subjectId
- - canView
- - canDownload
- - expiresAt
- properties:
- subjectId: {$ref: '#/StringId'}
- canView: {type: boolean}
- canDownload: {type: boolean}
- expiresAt: {$ref: '#/UtcDateTime'}
- SavePermissionsRequest:
- type: object
- additionalProperties: false
- required: [documentRowVersion, entries]
- properties:
- documentRowVersion: {type: integer, minimum: 0}
- entries:
- type: array
- items: {$ref: '#/SavePermissionEntry'}
- description: 调阅授权全集(非增量补丁);仅用户主体,expiresAt必须晚于当前时间且不超过当前时间+7天(服务端含60秒容差);保存不触碰审批单凭证。
- PermissionDetail:
- type: object
- additionalProperties: false
- required:
- - documentId
- - sourceDocumentId
- - inherited
- - documentRowVersion
- - entries
- properties:
- documentId: {$ref: '#/StringId'}
- sourceDocumentId: {$ref: '#/StringId'}
- inherited: {type: boolean}
- documentRowVersion: {type: integer, minimum: 0}
- entries:
- type: array
- items: {$ref: '#/PermissionEntry'}
- description: 按subjectId升序返回全部未删除授权(含已到期条目,由前端标记)。
- PermissionVoucherResult:
- type: object
- additionalProperties: false
- required: [documentId, entryId, voucherFileName, voucherFileSize, voucherUploadedAt]
- properties:
- documentId: {$ref: '#/StringId'}
- entryId: {$ref: '#/StringId'}
- voucherFileName: {type: string}
- voucherFileSize: {type: integer, minimum: 1}
- voucherUploadedAt: {$ref: '#/UtcDateTime'}
- PermissionVoucherResultResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/PermissionVoucherResult'}
- requestId: {type: string, format: uuid}
- PermissionVoucherDeleteResult:
- type: object
- additionalProperties: false
- required: [documentId, entryId]
- properties:
- documentId: {$ref: '#/StringId'}
- entryId: {$ref: '#/StringId'}
- PermissionVoucherDeleteResultResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/PermissionVoucherDeleteResult'}
- requestId: {type: string, format: uuid}
- 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
- - attachmentTypes
- - deptScopes
- - allowedActions
- - categoryTypes
- - enabledStatuses
- - auditResults
- - auditActions
- - auditTargets
- properties:
- roleCodes: {$ref: '#/DictionaryOptionList'}
- allowedModules: {$ref: '#/DictionaryOptionList'}
- documentTypes: {$ref: '#/DictionaryOptionList'}
- documentStatuses: {$ref: '#/DictionaryOptionList'}
- securityLevels: {$ref: '#/DictionaryOptionList'}
- attachmentTypes: {$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}
- RolePasswordAssignment:
- type: object
- additionalProperties: false
- required: [roleId, password]
- properties:
- roleId: {$ref: '#/StringId'}
- password:
- type: string
- nullable: true
- minLength: 8
- maxLength: 64
- writeOnly: true
- description: 该角色独立密码;null=该角色使用用户级密码(契约1.53)。
- CreateUserRequest:
- type: object
- additionalProperties: false
- required: [username, realName, initialPassword, organizationId, roleCode, roleIds, securityLevel, status]
- properties:
- username:
- type: string
- minLength: 1
- maxLength: 64
- description: 登录用户名(契约1.51):界面录入的即姓名,与realName同值写入;非空且≤64字符,无字符集限制(中文姓名直接可用)。
- realName:
- type: string
- minLength: 1
- maxLength: 64
- description: 姓名(契约1.47/1.50):界面不再单独录入,创建时由用户名同步写入(前端自动填充,接口仍要求非空);活跃用户中唯一(应用层校验不加库约束),冲突返回409「姓名已存在」;登录与重置密码仍兼容按姓名唯一命中解析存量用户。
- initialPassword: {type: string, format: password, minLength: 8, maxLength: 64, writeOnly: true}
- organizationId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- roleCode: {$ref: '#/RoleCode'}
- roleIds:
- type: array
- uniqueItems: true
- description: 挂载角色ID列表(契约1.46 多角色);空数组=无挂载(登录走默认角色),逐角色校验有效且不越管理范围。
- items: {$ref: '#/StringId'}
- rolePasswords:
- type: array
- description: 角色密码分配(契约1.53 密码即角色);挂载≥2角色时必填——须覆盖全部挂载角色且恰一个password=null(使用用户密码),独立密码满足策略、两两互异且不等于initialPassword(冲突400 PASSWORD_CONFLICT);挂载≤1提交返回400「仅多角色需要分配角色密码」。
- items: {$ref: '#/RolePasswordAssignment'}
- seatName:
- type: string
- nullable: true
- maxLength: 64
- description: 席位(契约1.46,可选);空/null=不设置。
- userType:
- type: string
- enum: [NORMAL, COMMANDER]
- description: 用户类型(契约1.46,可选,缺省NORMAL);COMMANDER=首长(仍属USER类别)。
- securityLevel: {$ref: '#/SecurityLevel'}
- status: {$ref: '#/EnabledStatus'}
- managedOrgId:
- type: string
- nullable: true
- description: 用户级管理范围(契约1.30,可选);null=全局、机构ID=固定锚点(须指向未删除机构)。省略或"SELF"时跟随该用户所在机构(落库哨兵0)。
- UpdateUiThemeRequest:
- type: object
- additionalProperties: false
- required: [uiTheme]
- properties:
- uiTheme: {type: string, enum: [blue, red, green]}
- UpdateUserRequest:
- type: object
- additionalProperties: false
- required: [realName, organizationId, roleCode, roleIds, securityLevel, status, rowVersion]
- properties:
- realName:
- type: string
- minLength: 1
- maxLength: 64
- description: 姓名(契约1.47/1.50):界面不再可编辑,编辑提交保持原值;活跃用户中唯一(应用层校验排除自身,不加库约束),冲突返回409「姓名已存在」。
- organizationId:
- allOf: [{$ref: '#/StringId'}]
- nullable: true
- roleCode: {$ref: '#/RoleCode'}
- roleIds:
- type: array
- uniqueItems: true
- description: 挂载角色ID列表(契约1.46 多角色);以活跃启用挂载为基线做差集增删,空数组=清空活跃挂载(停用角色关联保留不动,重新启用后自动恢复生效),diff变化联动authVersion+1使旧Token失效。
- items: {$ref: '#/StringId'}
- rolePasswords:
- type: array
- description: 角色密码分配(契约1.53 密码即角色);仅挂载变化时受理——结果≥2须提交全量分配(恰一个password=null、独立密码互异且不等于用户级密码(以旧哈希verify比对)),≤1时省略(服务端清空全部挂载行密码);挂载未变提交返回400「挂载角色未变化,无需重新分配角色密码」。
- items: {$ref: '#/RolePasswordAssignment'}
- seatName:
- type: string
- nullable: true
- maxLength: 64
- description: 席位(契约1.46,可选);null=清空。
- userType:
- type: string
- enum: [NORMAL, COMMANDER]
- description: 用户类型(契约1.46,可选,缺省NORMAL);COMMANDER=首长(仍属USER类别)。
- securityLevel: {$ref: '#/SecurityLevel'}
- status: {$ref: '#/EnabledStatus'}
- managedOrgId:
- type: string
- nullable: true
- description: 用户级管理范围(契约1.30,可选);null=全局、机构ID=固定锚点(须指向未删除机构)、"SELF"=跟随该用户所在机构(落库哨兵0)。省略时保持原值不变。
- 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}
- DeptScope:
- type: string
- description: 权限矩阵部门范围:所属部门方案/其他部门方案(其他部门含所属部门子树外全部部门与无归属文档)。
- enum: [OWN, OTHER]
- RoleSummary:
- type: object
- additionalProperties: false
- required: [id, roleName, sortNo, status, remark, isDefault, manageCategoryEdit, manageOrgEdit, manageUserEdit, manageSystemManage, manageAuditLog, manageRoleEdit, managedOrgId, 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}
- manageCategoryEdit: {type: boolean, description: 分类编辑管理位(仅对ADMIN类别用户生效)}
- manageOrgEdit: {type: boolean, description: 机构编辑管理位(仅对ADMIN类别用户生效)}
- manageUserEdit: {type: boolean, description: 用户编辑管理位(仅对ADMIN类别用户生效)}
- manageSystemManage: {type: boolean, description: 系统管理管理位(契约1.23,仅对ADMIN类别用户生效)}
- manageAuditLog: {type: boolean, description: 日志审计管理位(契约1.23,仅对ADMIN类别用户生效)}
- manageRoleEdit: {type: boolean, description: 角色编辑管理位(契约1.25,仅对ADMIN类别用户生效,全局生效不受锚点约束)}
- managedOrgId:
- type: string
- nullable: true
- description: 管理范围锚点(契约1.30);机构ID、"SELF"(跟随用户的管理范围设置,落库哨兵0)或null(全局)。
- 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, manageCategoryEdit, manageOrgEdit, manageUserEdit, manageSystemManage, manageAuditLog, manageRoleEdit, managedOrgId]
- 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}
- manageCategoryEdit: {type: boolean}
- manageOrgEdit: {type: boolean}
- manageUserEdit: {type: boolean}
- manageSystemManage: {type: boolean}
- manageAuditLog: {type: boolean}
- manageRoleEdit: {type: boolean}
- managedOrgId:
- type: string
- nullable: true
- description: 管理范围锚点(契约1.30);机构ID、"SELF"(跟随用户的管理范围设置,落库哨兵0)或null/空串(全局),机构ID须指向未删除机构。
- UpdateRoleRequest:
- type: object
- additionalProperties: false
- required: [roleName, sortNo, status, remark, isDefault, manageCategoryEdit, manageOrgEdit, manageUserEdit, manageSystemManage, manageAuditLog, manageRoleEdit, managedOrgId, 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}
- manageCategoryEdit: {type: boolean}
- manageOrgEdit: {type: boolean}
- manageUserEdit: {type: boolean}
- manageSystemManage: {type: boolean}
- manageAuditLog: {type: boolean}
- manageRoleEdit: {type: boolean}
- managedOrgId:
- type: string
- nullable: true
- description: 管理范围锚点(契约1.30);机构ID、"SELF"(跟随用户的管理范围设置,落库哨兵0)或null/空串(全局),机构ID须指向未删除机构。
- 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: [topCategoryId, docKind, securityLevel, deptScope, canView, canUpload, canDownload, canEdit, canDelete, canConfigPermission, canBindAttachment, canUnbindAttachment, canAttachmentUpload, canAttachmentEdit, canAttachmentView, canAttachmentDownload, canAttachmentDelete]
- properties:
- topCategoryId:
- type: string
- nullable: true
- description: 一级分类id(契约1.48);null=共享资料库行组(未挂载附件判定专用)。
- docKind:
- type: string
- enum: [MAIN, ACCOMPANYING_PLAN, SUPPORT_ACHIEVEMENT, TRAINING_MATERIAL, TYPICAL_CASE]
- description: 种类维度(契约1.48);MAIN=主体方案(主案8位),附件四类型=共享资料(恒OWN行,附件5位)。
- securityLevel: {$ref: '#/SecurityLevel'}
- deptScope: {$ref: '#/DeptScope'}
- canView: {type: boolean}
- canUpload:
- type: boolean
- description: 上传位(契约1.31);仅 OWN 行有意义,OTHER 行恒为 false,服务端提交校验拒收 OTHER 行为 true 的载荷。
- canDownload: {type: boolean}
- canEdit: {type: boolean}
- canDelete: {type: boolean}
- canConfigPermission: {type: boolean}
- canBindAttachment: {type: boolean}
- canUnbindAttachment: {type: boolean}
- canAttachmentUpload:
- type: boolean
- description: 附件上传位(契约1.41);共享附件库上传文档的权限,不含挂载操作;仅 OWN 行有意义(附件无部门归属),OTHER 行恒为 false。
- canAttachmentEdit:
- type: boolean
- description: 附件编辑位(契约1.41);覆盖共享附件库与已挂载区域附件的编辑;仅 OWN 行有意义。
- canAttachmentView:
- type: boolean
- description: 附件查看位(契约1.41);不跟随主案权限,配置即独立可查看附件;仅 OWN 行有意义。
- canAttachmentDownload:
- type: boolean
- description: 附件下载位(契约1.41);不跟随主案权限,配置即独立可下载附件;仅 OWN 行有意义。
- canAttachmentDelete:
- type: boolean
- description: 附件删除位(契约1.44);附件删除不再按ADMIN类别专属,配置即独立可删除附件;仅 OWN 行有意义。
- 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: 20
- description: 行数动态=期望键集(契约1.48 一级分类×种类×密级×部门范围),服务端读时归一化输出。
- items:
- $ref: '#/RolePermissionRow'
- requestId: {type: string, format: uuid}
- UpdateRolePermissionsRequest:
- type: object
- additionalProperties: false
- required: [matrix, rowVersion]
- properties:
- matrix:
- type: array
- minItems: 20
- description: 行数动态=期望键集(契约1.48 一级分类×种类×密级×部门范围),服务端读时归一化输出。
- 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: 20
- description: 行数动态=期望键集(契约1.48 一级分类×种类×密级×部门范围),服务端读时归一化输出。
- 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]
- description: 角色挂载用户(契约1.46 关联表化);userIds为该角色全部活跃启用挂载用户的ID列表。
- 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]
- description: 整体替换该角色的活跃挂载用户集合(契约1.46);只增删本角色关联,成员变动联动对端用户authVersion+1使旧Token失效。
- 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}
- DocumentMoveRequest:
- type: object
- additionalProperties: false
- description: targetPosition与target二选一(非法组合返回400);主案可携带scopeCategoryId(分类子树语义),配套方案携带返回400。
- properties:
- targetPosition: {type: integer, minimum: 1}
- target: {type: string, enum: [TOP, BOTTOM]}
- scopeCategoryId: {$ref: '#/StringId'}
- DocumentMoveResult:
- type: object
- additionalProperties: false
- required: [position, total]
- properties:
- position: {type: integer, minimum: 1}
- total: {type: integer, minimum: 0}
- DocumentMoveResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/DocumentMoveResult'}
- requestId: {type: string, format: uuid}
- AttachmentMoveRequest:
- type: object
- additionalProperties: false
- required: [mainPlanRowVersion]
- description: targetPosition与target二选一(非法组合返回400);scopeAttachmentType限定页签类型范围。
- properties:
- mainPlanRowVersion: {type: integer, minimum: 0}
- targetPosition: {type: integer, minimum: 1}
- target: {type: string, enum: [TOP, BOTTOM]}
- scopeAttachmentType: {$ref: '#/AttachmentType'}
- AttachmentMoveResult:
- type: object
- additionalProperties: false
- required: [position, total, mainPlanRowVersion]
- properties:
- position: {type: integer, minimum: 1}
- total: {type: integer, minimum: 0}
- mainPlanRowVersion: {type: integer, minimum: 0}
- AttachmentMoveResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/AttachmentMoveResult'}
- requestId: {type: string, format: uuid}
- 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网段或IP范围文本(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}
- BackupTargetMode:
- type: string
- enum: [LOCAL, RSYNC]
- description: 备份目标模式:LOCAL 本机目录(开发/单机),RSYNC rsync守护进程异机传输。
- BackupTypeCode:
- type: string
- enum: [FULL, INCREMENTAL]
- BackupTrigger:
- type: string
- enum: [MANUAL, SCHEDULE]
- BackupPhase:
- type: string
- description: 备份任务阶段;null表示从未运行过任何任务。
- enum: [SCANNING, EXPORTING_DB, COPYING, PUSHING, CLEANING, SUCCESS, FAILED]
- BackupConfigView:
- type: object
- additionalProperties: false
- required: [target_mode, local_path, rsync_url, schedule_enabled, schedule_time, full_interval_days, retain_full_count, rsync_password_set]
- properties:
- target_mode: {$ref: '#/BackupTargetMode'}
- local_path: {type: string, maxLength: 1024, description: LOCAL模式的备份根目录;未配置为空串。}
- rsync_url: {type: string, maxLength: 1024, description: RSYNC模式目标地址 rsync://user@host:873/module/;未配置为空串。}
- schedule_enabled: {type: boolean, description: 定时备份开关。}
- schedule_time: {type: string, pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]$', description: 每日触发时刻(HH:MM,业务时区)。}
- full_interval_days: {type: integer, minimum: 1, maximum: 365, description: 定时任务距最近全量超过该天数时自动升级为全量。}
- retain_full_count: {type: integer, minimum: 1, maximum: 100, description: 保留的完整备份链数量;超出部分从最旧链开始清理。}
- rsync_password_set: {type: boolean, description: rsync密码是否已设置;密码永不回显明文。}
- UpdateBackupConfigRequest:
- type: object
- additionalProperties: false
- required: [target_mode, local_path, rsync_url, rsync_password, schedule_enabled, schedule_time, full_interval_days, retain_full_count]
- properties:
- target_mode: {$ref: '#/BackupTargetMode'}
- local_path: {type: string, nullable: true, maxLength: 1024}
- rsync_url: {type: string, nullable: true, maxLength: 1024}
- rsync_password:
- type: string
- nullable: true
- maxLength: 256
- writeOnly: true
- description: rsync密码;null或空串表示保持已存密码不变(回显永不回明文)。
- schedule_enabled: {type: boolean}
- schedule_time: {type: string, pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]$'}
- full_interval_days: {type: integer, minimum: 1, maximum: 365}
- retain_full_count: {type: integer, minimum: 1, maximum: 100}
- BackupConfigResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BackupConfigView'}
- requestId: {type: string, format: uuid}
- BackupJobStartRequest:
- type: object
- additionalProperties: false
- required: [type]
- properties:
- type:
- allOf: [{$ref: '#/BackupTypeCode'}]
- description: INCREMENTAL无可用全量链时服务端自动升级为FULL。
- BackupProgress:
- type: object
- additionalProperties: false
- required: [backupId, type, trigger, phase, bytesTotal, bytesCopied, filesTotal, filesCopied, pushPercent, error, startedAt, finishedAt]
- properties:
- backupId:
- type: string
- nullable: true
- description: 备份ID,形如 dms-bak-yyyyMMdd-HHmmss-F/-I;从未运行时为null。
- type:
- allOf: [{$ref: '#/BackupTypeCode'}]
- nullable: true
- trigger:
- allOf: [{$ref: '#/BackupTrigger'}]
- nullable: true
- phase:
- allOf: [{$ref: '#/BackupPhase'}]
- nullable: true
- bytesTotal: {type: integer, minimum: 0, description: 待传输字节总量(扫描/拷贝阶段累计)。}
- bytesCopied: {type: integer, minimum: 0}
- filesTotal: {type: integer, minimum: 0}
- filesCopied: {type: integer, minimum: 0}
- pushPercent:
- type: integer
- minimum: 0
- maximum: 100
- nullable: true
- description: rsync整体推送进度百分比;仅RSYNC模式PUSHING阶段有值。
- error:
- type: string
- nullable: true
- description: 失败原因;仅FAILED阶段非null。
- startedAt:
- type: string
- nullable: true
- description: 开始时间(业务时区本地时间,yyyy-MM-dd HH:mm:ss,非UTC)。
- finishedAt:
- type: string
- nullable: true
- description: 结束时间(业务时区本地时间,yyyy-MM-dd HH:mm:ss,非UTC)。
- BackupJobStartResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BackupProgress'}
- requestId: {type: string, format: uuid}
- BackupCurrentJob:
- allOf:
- - $ref: '#/BackupProgress'
- - type: object
- required: [running]
- properties:
- running: {type: boolean, description: 当前是否有备份任务在执行。}
- BackupJobCurrentResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BackupCurrentJob'}
- requestId: {type: string, format: uuid}
- BackupCancelData:
- type: object
- additionalProperties: false
- required: [canceled]
- properties:
- canceled: {type: boolean, description: 请求取消时是否存在运行中的任务。}
- BackupCancelResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BackupCancelData'}
- requestId: {type: string, format: uuid}
- BackupHistoryEntry:
- type: object
- additionalProperties: false
- required: [id, type, parent, started_at, finished_at, database_file, database_size, transferred_files, transferred_bytes, storage_file_count, storage_total_bytes]
- properties:
- id: {type: string, description: 备份ID dms-bak-yyyyMMdd-HHmmss-F(全量)/-I(增量)。}
- type: {$ref: '#/BackupTypeCode'}
- parent:
- type: string
- nullable: true
- description: 增量备份的前驱备份ID;全量为null。
- started_at: {type: string, description: 开始时间(业务时区本地时间,yyyy-MM-dd HH:mm:ss)。}
- finished_at: {type: string, description: 结束时间(业务时区本地时间,yyyy-MM-dd HH:mm:ss)。}
- database_file: {type: string, description: 数据库导出文件在备份包内的相对路径。}
- database_size: {type: integer, minimum: 0, description: 数据库导出文件字节数。}
- transferred_files: {type: integer, minimum: 0, description: 本次实际传输的存储文件数(全量为全部,增量为差异)。}
- transferred_bytes: {type: integer, minimum: 0}
- storage_file_count: {type: integer, minimum: 0, description: 合并清单中的存储文件总数(链尾累计口径)。}
- storage_total_bytes: {type: integer, minimum: 0}
- BackupHistoryData:
- type: object
- additionalProperties: false
- required: [entries]
- properties:
- entries:
- type: array
- items: {$ref: '#/BackupHistoryEntry'}
- description: 按备份ID升序(即时间升序)排列。
- BackupHistoryResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BackupHistoryData'}
- requestId: {type: string, format: uuid}
- SystemCpuSnapshot:
- type: object
- additionalProperties: false
- required: [percent, coreCount, loadAvgOneMinute]
- properties:
- percent: {type: number, minimum: 0, maximum: 100, description: CPU 总占用百分比(0.3 秒采样窗口)。}
- coreCount: {type: integer, minimum: 0, description: 逻辑核数。}
- loadAvgOneMinute:
- type: number
- nullable: true
- description: 1 分钟平均负载(仅 POSIX,Windows 为 null)。
- SystemMemorySnapshot:
- type: object
- additionalProperties: false
- required: [totalBytes, usedBytes, availableBytes, usedPercent]
- properties:
- totalBytes: {type: integer, minimum: 0}
- usedBytes: {type: integer, minimum: 0}
- availableBytes: {type: integer, minimum: 0}
- usedPercent: {type: number, minimum: 0, maximum: 100}
- SystemSwapSnapshot:
- type: object
- additionalProperties: false
- required: [totalBytes, usedBytes, usedPercent]
- properties:
- totalBytes: {type: integer, minimum: 0}
- usedBytes: {type: integer, minimum: 0}
- usedPercent: {type: number, minimum: 0, maximum: 100}
- SystemDiskSnapshot:
- type: object
- additionalProperties: false
- required: [device, mountpoint, fstype, totalBytes, usedBytes, freeBytes, usedPercent]
- properties:
- device: {type: string, description: 设备名。}
- mountpoint: {type: string, description: 挂载点。}
- fstype: {type: string, description: 文件系统类型。}
- totalBytes: {type: integer, minimum: 0}
- usedBytes: {type: integer, minimum: 0}
- freeBytes: {type: integer, minimum: 0}
- usedPercent: {type: number, minimum: 0, maximum: 100}
- SystemMetricsCurrentData:
- type: object
- additionalProperties: false
- required: [cpu, memory, swap, disks, bootAt]
- properties:
- cpu: {$ref: '#/SystemCpuSnapshot'}
- memory: {$ref: '#/SystemMemorySnapshot'}
- swap: {$ref: '#/SystemSwapSnapshot'}
- disks:
- type: array
- items: {$ref: '#/SystemDiskSnapshot'}
- description: 物理磁盘分区占用(不可读分区跳过)。
- bootAt: {type: string, description: 开机时间(UTC,毫秒精度 Z 结尾)。}
- SystemMetricsCurrentResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemMetricsCurrentData'}
- requestId: {type: string, format: uuid}
- SystemMetricHistoryEntry:
- type: object
- additionalProperties: false
- required: [sampledAt, cpuPercent, memUsedBytes, memTotalBytes]
- properties:
- sampledAt: {type: string, description: 采样时间(UTC,毫秒精度 Z 结尾)。}
- cpuPercent:
- type: number
- nullable: true
- description: CPU 百分比(采集失败为 null)。
- memUsedBytes: {type: integer, minimum: 0}
- memTotalBytes: {type: integer, minimum: 0}
- SystemMetricHistoryData:
- type: object
- additionalProperties: false
- required: [hours, entries]
- properties:
- hours: {type: integer, minimum: 1, description: 查询窗口小时数。}
- entries:
- type: array
- items: {$ref: '#/SystemMetricHistoryEntry'}
- description: 按时间升序排列。
- SystemMetricHistoryResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemMetricHistoryData'}
- requestId: {type: string, format: uuid}
- SystemProcessData:
- type: object
- additionalProperties: false
- required: [pid, cpuPercent, memoryRssBytes, memoryVmsBytes, threadCount, startedAt, uptimeSeconds, pythonVersion]
- properties:
- pid: {type: integer, minimum: 1}
- cpuPercent: {type: number, description: 进程 CPU 占用(按核数归一后的百分比)。}
- memoryRssBytes: {type: integer, minimum: 0, description: 常驻内存。}
- memoryVmsBytes: {type: integer, minimum: 0, description: 虚拟内存。}
- threadCount: {type: integer, minimum: 1}
- startedAt: {type: string, description: 进程启动时间(UTC,毫秒精度 Z 结尾)。}
- uptimeSeconds: {type: integer, minimum: 0}
- pythonVersion: {type: string, description: 运行时版本(Java 版返回 JDK 版本)。}
- SystemProcessResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemProcessData'}
- requestId: {type: string, format: uuid}
- SystemStorageUsageEntry:
- type: object
- additionalProperties: false
- required: [directory, totalBytes, fileCount]
- properties:
- directory: {type: string, description: 存储子目录名(original/preview/extracted/temporary/quarantine/recycle/voucher)。}
- totalBytes: {type: integer, minimum: 0}
- fileCount: {type: integer, minimum: 0}
- SystemStorageUsageData:
- type: object
- additionalProperties: false
- required: [entries]
- properties:
- entries:
- type: array
- items: {$ref: '#/SystemStorageUsageEntry'}
- SystemStorageUsageResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemStorageUsageData'}
- requestId: {type: string, format: uuid}
- SystemConverterData:
- type: object
- additionalProperties: false
- required: [available, executable, maxConcurrency, inFlight, successCount, failureCount, previewEnabled, timeoutSeconds]
- properties:
- available: {type: boolean, description: 转换器是否可用。}
- executable: {type: string, description: LibreOffice 可执行文件路径。}
- maxConcurrency: {type: integer, minimum: 1, description: 并发上限。}
- inFlight: {type: integer, minimum: 0, description: 进行中的转换数。}
- successCount: {type: integer, minimum: 0, description: 累计成功转换数(进程生命周期内)。}
- failureCount: {type: integer, minimum: 0, description: 累计失败转换数(进程生命周期内)。}
- previewEnabled: {type: boolean, description: 预览转换功能是否启用。}
- timeoutSeconds: {type: integer, minimum: 1, description: 单次转换超时秒数。}
- SystemConverterResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemConverterData'}
- requestId: {type: string, format: uuid}
- SystemHealthItem:
- type: object
- additionalProperties: false
- required: [item, ok, detail]
- properties:
- item:
- type: string
- enum: [DATABASE, STORAGE_WRITABLE, LIBREOFFICE, BACKUP_TARGET, STORAGE_ENCRYPTION]
- ok: {type: boolean}
- detail: {type: string, description: 失败原因或补充说明(成功为空/说明文字)。}
- SystemHealthData:
- type: object
- additionalProperties: false
- required: [items]
- properties:
- items:
- type: array
- items: {$ref: '#/SystemHealthItem'}
- SystemHealthResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemHealthData'}
- requestId: {type: string, format: uuid}
- SystemInfoData:
- type: object
- additionalProperties: false
- required: [contractVersion, backendKind, runtimeVersion, operatingSystem, hostname, machineArch, databaseType, startedAt, uptimeSeconds, workingDirectory, storageRoot, backupConfigPath, envFilePath, logFilePath, monitoringEnabled]
- properties:
- contractVersion: {type: string, description: 接口契约版本(如 1.26.0)。}
- backendKind: {type: string, enum: [PYTHON, JAVA], description: 后端实现类型。}
- runtimeVersion: {type: string, description: 运行时版本(Python/JDK)。}
- operatingSystem: {type: string}
- hostname: {type: string}
- machineArch: {type: string, description: 体系结构(x86_64/aarch64 等)。}
- databaseType: {type: string, description: 数据库类型描述(DM (达梦)/MySQL 等)。}
- startedAt: {type: string, description: 进程启动时间(UTC;psutil 缺失为空串)。}
- uptimeSeconds: {type: integer, minimum: 0}
- workingDirectory: {type: string}
- storageRoot: {type: string}
- backupConfigPath: {type: string}
- envFilePath: {type: string}
- logFilePath: {type: string, description: 运行日志文件路径(未启用为空串)。}
- monitoringEnabled: {type: boolean, description: 监控信息展示开关(DMS_SYSTEM_MONITOR_ENABLED,缺省 false);false 时前端隐藏系统管理页维护操作之上的监控区块。}
- SystemInfoResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemInfoData'}
- requestId: {type: string, format: uuid}
- SystemRuntimeConfigEntry:
- type: object
- additionalProperties: false
- required: [category, key, value, unit]
- properties:
- category: {type: string, description: 分类(认证/存储/上传/业务/转换/安全)。}
- key: {type: string, description: 参数显示名。}
- value:
- description: 参数值(密钥类仅显示 已配置/未配置,永不回明文)。
- unit: {type: string, description: 单位(无单位为空串)。}
- SystemRuntimeConfigData:
- type: object
- additionalProperties: false
- required: [entries]
- properties:
- entries:
- type: array
- items: {$ref: '#/SystemRuntimeConfigEntry'}
- SystemRuntimeConfigResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemRuntimeConfigData'}
- requestId: {type: string, format: uuid}
- SystemLogsData:
- type: object
- additionalProperties: false
- required: [file, lines, truncated]
- properties:
- file: {type: string, description: 日志文件路径(未启用为空串)。}
- lines:
- type: array
- items: {type: string}
- description: 尾部日志行(级别过滤后截尾)。
- truncated: {type: boolean, description: 是否经过截断。}
- error:
- type: string
- description: 读取失败原因(成功时无此字段)。
- SystemLogsResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemLogsData'}
- requestId: {type: string, format: uuid}
- SystemPreviewCacheClearData:
- type: object
- additionalProperties: false
- required: [removedFiles, removedBytes]
- properties:
- removedFiles: {type: integer, minimum: 0, description: 删除的预览文件数。}
- removedBytes: {type: integer, minimum: 0, description: 释放的字节数。}
- SystemPreviewCacheClearResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemPreviewCacheClearData'}
- requestId: {type: string, format: uuid}
- SystemForceOfflineData:
- type: object
- additionalProperties: false
- required: [userId, username, realName, authVersion]
- properties:
- userId: {type: string, description: 目标用户ID(字符串形式)。}
- username: {type: string}
- realName: {type: string, description: 目标用户姓名(契约1.47):前端提示展示姓名。}
- authVersion: {type: integer, minimum: 1, description: 目标用户当前 auth_version(已 +1)。}
- SystemForceOfflineResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/SystemForceOfflineData'}
- requestId: {type: string, format: uuid}
- BackupTestTargetData:
- type: object
- additionalProperties: false
- required: [ok]
- properties:
- ok: {type: boolean, description: 目标是否可写。}
- target:
- type: string
- description: 目标描述(成功时返回)。
- error:
- type: string
- description: 失败原因(失败时返回)。
- BackupTestTargetResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BackupTestTargetData'}
- requestId: {type: string, format: uuid}
- NotificationSummary:
- type: object
- additionalProperties: false
- required: [id, title, notifyType, action, status, createdAt]
- properties:
- id: {$ref: '#/StringId'}
- title: {type: string, description: 通知标题。}
- content: {type: string, description: 通知内容说明。}
- notifyType:
- type: string
- enum: [APPROVAL, PASSWORD_RESET]
- description: 通知类别(APPROVAL=调阅审批待办;PASSWORD_RESET=重置密码审批待办/结果,1.49新增)。
- bizId:
- allOf:
- - $ref: '#/StringId'
- description: 关联业务ID(1.37新增,APPROVAL待办指向调阅申请单;1.49起PASSWORD_RESET指向重置密码申请单,其余为null)。
- action:
- type: string
- enum: [NONE, PENDING, AGREE, REJECT]
- description: 待办操作(NONE=无需操作,PENDING=待处理,AGREE/REJECT=已同意/已拒绝)。
- status:
- type: string
- enum: [UNREAD, READ]
- description: 已读状态。
- createdAt: {type: string, format: date-time, description: 创建时间(UTC毫秒精度)。}
- handledAt: {type: string, format: date-time, description: 处理时间(同意/拒绝时)。}
- NotificationListData:
- type: object
- additionalProperties: false
- required: [items]
- properties:
- items:
- type: array
- items: {$ref: '#/NotificationSummary'}
- NotificationListResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/NotificationListData'}
- requestId: {type: string, format: uuid}
- NotificationUnreadCountData:
- type: object
- additionalProperties: false
- required: [count]
- properties:
- count: {type: integer, minimum: 0, description: 未读通知条数。}
- NotificationUnreadCountResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/NotificationUnreadCountData'}
- requestId: {type: string, format: uuid}
- NotificationReadAllData:
- type: object
- additionalProperties: false
- required: [updated]
- properties:
- updated: {type: integer, minimum: 0, description: 本次标记已读的条数。}
- NotificationReadAllResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/NotificationReadAllData'}
- requestId: {type: string, format: uuid}
- HandleNotificationRequest:
- type: object
- additionalProperties: false
- required: [action]
- properties:
- action:
- type: string
- enum: [AGREE, REJECT]
- description: 处理动作(同意/拒绝)。
- NotificationResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/NotificationSummary'}
- requestId: {type: string, format: uuid}
- BorrowRequestEntryInput:
- type: object
- additionalProperties: false
- required: [subjectId, canView, canDownload]
- properties:
- subjectId: {$ref: '#/StringId'}
- canView: {type: boolean, description: 调阅人查看位。}
- canDownload: {type: boolean, description: 调阅人下载位(查看与下载至少一项为true)。}
- BorrowRequestCreateRequest:
- type: object
- additionalProperties: false
- required: [entries, expiresAt]
- description: 调阅申请载荷(multipart的request part为该对象的JSON字符串)。
- properties:
- entries:
- type: array
- minItems: 1
- items: {$ref: '#/BorrowRequestEntryInput'}
- expiresAt:
- type: string
- format: date-time
- description: 到期时间(UTC毫秒精度Z结尾,须晚于当前时间,最长7天,服务端60秒容差)。
- BorrowRequestCreateResultData:
- type: object
- additionalProperties: false
- required: [requestId, notified]
- properties:
- requestId: {$ref: '#/StringId'}
- notified: {type: integer, minimum: 0, description: 收到APPROVAL待办通知的审批人数。}
- BorrowRequestCreateResultResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BorrowRequestCreateResultData'}
- requestId: {type: string, format: uuid}
- BorrowRequestEntry:
- type: object
- additionalProperties: false
- required: [subjectId, subjectName, canView, canDownload]
- properties:
- subjectId: {$ref: '#/StringId'}
- subjectName: {type: string, description: 调阅人姓名。}
- canView: {type: boolean, description: 查看位。}
- canDownload: {type: boolean, description: 下载位。}
- BorrowRequestDetailData:
- type: object
- additionalProperties: false
- required: [requestId, documentId, documentName, requesterId, requesterName, entries, expiresAt, status, createdAt]
- properties:
- requestId: {$ref: '#/StringId'}
- documentId: {$ref: '#/StringId'}
- documentName: {type: string, description: 文档名称。}
- requesterId: {$ref: '#/StringId'}
- requesterName: {type: string, description: 申请人姓名。}
- entries:
- type: array
- items: {$ref: '#/BorrowRequestEntry'}
- expiresAt: {type: string, format: date-time, description: 到期时间(UTC毫秒精度)。}
- voucherFileName: {type: string, description: 审批单文件名(未上传为null)。}
- voucherFileSize: {type: integer, format: int64, description: 审批单字节数(未上传为null)。}
- status:
- type: string
- enum: [PENDING, APPROVED, REJECTED]
- description: 申请状态(任一审批人处理即定)。
- handledById:
- allOf:
- - $ref: '#/StringId'
- description: 处理人ID(未处理为null)。
- handledByName: {type: string, description: 处理人姓名(未处理为null)。}
- handledAt: {type: string, format: date-time, description: 处理时间(未处理为null)。}
- createdAt: {type: string, format: date-time, description: 申请时间(UTC毫秒精度)。}
- BorrowRequestDetailResponse:
- type: object
- additionalProperties: false
- required: [code, message, data, requestId]
- properties:
- code: {type: string, enum: [OK]}
- message: {type: string, enum: [success]}
- data: {$ref: '#/BorrowRequestDetailData'}
- requestId: {type: string, format: uuid}
|