start_job.asciidoc 902 B

12345678910111213141516171819202122232425262728293031323334
  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. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Start Rollup Job API allows you to start a job by ID.
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. <1> The ID of the job to start.
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned +{response}+ indicates if the start command was received.
  20. ["source","java",subs="attributes,callouts,macros"]
  21. --------------------------------------------------
  22. include-tagged::{doc-tests-file}[{api}-response]
  23. --------------------------------------------------
  24. <1> Whether or not the start job request was received.
  25. include::../execution.asciidoc[]