delete-expired-data.asciidoc 1.0 KB

12345678910111213141516171819202122232425262728293031323334
  1. --
  2. :api: delete-expired-data
  3. :request: DeleteExpiredRequest
  4. :response: DeleteExpiredResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Delete Expired Data API
  8. Delete expired {ml} data.
  9. The API accepts a +{request}+ and responds
  10. with a +{response}+ object.
  11. [id="{upid}-{api}-request"]
  12. ==== Delete Expired Data Request
  13. A `DeleteExpiredDataRequest` object does not require any arguments.
  14. ["source","java",subs="attributes,callouts,macros"]
  15. ---------------------------------------------------
  16. include-tagged::{doc-tests-file}[{api}-request]
  17. ---------------------------------------------------
  18. <1> Constructing a new request.
  19. [id="{upid}-{api}-response"]
  20. ==== Delete Expired Data Response
  21. The returned +{response}+ object indicates the acknowledgement of the request:
  22. ["source","java",subs="attributes,callouts,macros"]
  23. ---------------------------------------------------
  24. include-tagged::{doc-tests-file}[{api}-response]
  25. ---------------------------------------------------
  26. <1> `getDeleted` acknowledges the deletion request.
  27. include::../execution.asciidoc[]