47 lines
1.6 KiB
Plaintext
47 lines
1.6 KiB
Plaintext
--
|
|
:api: get-data-frame-transform
|
|
:request: GetDataFrameTransformRequest
|
|
:response: GetDataFrameTransformResponse
|
|
--
|
|
[id="{upid}-{api}"]
|
|
=== Get Data Frame Transform API
|
|
|
|
The Get Data Frame Transform API is used get one or more {dataframe-transform}.
|
|
The API accepts a +{request}+ object and returns a +{response}+.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Get Data Frame Request
|
|
|
|
A +{request}+ requires either a data frame transform id, a comma separated list of ids or
|
|
the special wildcard `_all` to get all {dataframe-transforms}
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> Constructing a new GET request referencing an existing {dataframe-transform}
|
|
|
|
==== Optional Arguments
|
|
|
|
The following arguments are optional.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request-options]
|
|
--------------------------------------------------
|
|
<1> The page parameters `from` and `size`. `from` specifies the number of
|
|
{dataframe-transforms} to skip. `size` specifies the maximum number of
|
|
{dataframe-transforms} to get. Defaults to `0` and `100` respectively.
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ contains the requested {dataframe-transform}s.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
-------------------------------------------------- |