start-transform.asciidoc 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[start-data-frame-transform]]
  4. === Start {dataframe-transforms} API
  5. ++++
  6. <titleabbrev>Start {dataframe-transforms}</titleabbrev>
  7. ++++
  8. Starts one or more {dataframe-transforms}.
  9. ==== Request
  10. `POST _data_frame/transforms/<data_frame_transform_id>/_start`
  11. //==== Description
  12. ==== Path Parameters
  13. `data_frame_transform_id` (required)::
  14. (string) Identifier for the {dataframe-transform}. This identifier can contain
  15. lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
  16. must start and end with alphanumeric characters.
  17. //==== Request Body
  18. //==== Authorization
  19. ==== Examples
  20. The following example starts the `ecommerce_transform` {dataframe-transform}:
  21. [source,js]
  22. --------------------------------------------------
  23. POST _data_frame/transforms/ecommerce_transform/_start
  24. --------------------------------------------------
  25. // CONSOLE
  26. // TEST[skip:set up kibana samples]
  27. When the {dataframe-transform} starts, you receive the following results:
  28. [source,js]
  29. ----
  30. {
  31. "started" : true
  32. }
  33. ----
  34. // TESTRESPONSE