start_job.asciidoc 920 B

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: rollup-start-job
  3. :request: StartRollupJobRequest
  4. :response: StartRollupJobResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Start Rollup Job API
  9. experimental::[]
  10. [id="{upid}-{api}-request"]
  11. ==== Request
  12. The Start Rollup Job API allows you to start a job by ID.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. --------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. --------------------------------------------------
  17. <1> The ID of the job to start.
  18. [id="{upid}-{api}-response"]
  19. ==== Response
  20. The returned +{response}+ indicates if the start command was received.
  21. ["source","java",subs="attributes,callouts,macros"]
  22. --------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-response]
  24. --------------------------------------------------
  25. <1> Whether or not the start job request was received.
  26. include::../execution.asciidoc[]