start-transform.asciidoc 1.1 KB

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