parameters.yaml 919 B

123456789101112131415161718192021222324252627282930313233
  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. UpdatedFrom:
  18. name: updatedFrom
  19. in: query
  20. required: false
  21. description: 文档自身updatedAt的闭区间开始边界,必须为UTC Z格式。
  22. schema:
  23. $ref: './schemas.yaml#/UtcDateTime'
  24. UpdatedTo:
  25. name: updatedTo
  26. in: query
  27. required: false
  28. description: 文档自身updatedAt的闭区间结束边界,必须为UTC Z格式,且不得早于updatedFrom。
  29. schema:
  30. $ref: './schemas.yaml#/UtcDateTime'