parameters.yaml 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. XRequestId:
  2. name: X-Request-Id
  3. in: header
  4. required: false
  5. description: 客户端生成的UUID;未提供时由后端生成。
  6. schema:
  7. type: string
  8. format: uuid
  9. XDocumentPassword:
  10. name: X-DMS-Document-Password
  11. in: header
  12. required: false
  13. description: 主案密码锁口令;操作被密码保护且当前用户需要口令时必填(缺失返回DOCUMENT_PASSWORD_REQUIRED,错误返回DOCUMENT_PASSWORD_INVALID)。
  14. schema:
  15. type: string
  16. maxLength: 128
  17. XDmsReauthToken:
  18. name: X-DMS-Reauth-Token
  19. in: header
  20. required: false
  21. description: 敏感操作二次认证令牌(POST /auth/reauth签发,5分钟有效);缺失/无效/过期/非本人/authVersion不符返回403 REAUTH_REQUIRED。
  22. schema:
  23. type: string
  24. UpdatedFrom:
  25. name: updatedFrom
  26. in: query
  27. required: false
  28. description: 文档自身updatedAt的闭区间开始边界,必须为UTC Z格式。
  29. schema:
  30. $ref: './schemas.yaml#/UtcDateTime'
  31. UpdatedTo:
  32. name: updatedTo
  33. in: query
  34. required: false
  35. description: 文档自身updatedAt的闭区间结束边界,必须为UTC Z格式,且不得早于updatedFrom。
  36. schema:
  37. $ref: './schemas.yaml#/UtcDateTime'