From RestApi

Basic parameters

Requested Data Path

Path of the requested data

Yes

/api/getUsers

Request Method

Request method. The value can be GET or POST.

Yes

GET

Request Header

This header and the connection header will be combined to form the task header.

The header follows this format: {"Content-Type":"application/json"}.

Yes

{"Content-Type":"application/json"}

Request Body

This parameter is available when Request Method is POST.

The request body is in JSON format.

Yes

{"namePrefix":"test"}

Paging Interface

Whether the interface is a paging interface

Yes

-

Records Obtained Each Time

This parameter is displayed when Paging Interface is set to Yes.

It indicates the number of data records obtained each time.

Yes

1000

Page Size

This parameter is displayed when Paging Interface is set to Yes.

In indicates the page size.

• By default, this parameter is placed in query parameters. The value of this parameter is the number of records obtained each time.
• If body parameters include this parameter, its value will be replaced by the number of records pulled each time.

Yes

pageSize

Page Number

This parameter is displayed when Paging Interface is set to Yes.

In indicates the page number.

• By default, this parameter is placed in query parameters. The value of this parameter is the page number.
• If this parameter is included in body parameters, its value will be replaced with the page number.

Yes

pageNumber

Data Path

Location of data in the response JSON body. The default value is the root path.

For example, if the response body is {"data":{"students":[{"customerConfig":{"flavorType":"cdm.large","clusterName":"mppdbCluster"}}]}} and the second-layer students data needs to be parsed, set this parameter to data.students.

No

data.students

Data Records

This parameter is displayed when Paging Interface is set to Yes.

It indicates the total number of data records. The value can be a fixed value or obtained using an API. the interface. The value can also be a SpEL expression.

• Fixed value
• Obtain using an API: data.pageCount
  NOTE:

  If you want to call a non-pagination API only once, set the value of this parameter to less than or equal to the number of data records obtained each time.

Yes

Recommended fixed value: 1,000