Help Center/ DataArts Studio/ User Guide/ DataArts Factory/ Offline Processing Migration Job Development/ Configuring Source Job Parameters/ From Rest Client
Updated on 2024-10-28 GMT+08:00
View PDF
Share

From Rest Client

Table 1 Parameter description

Parameter

Description

Example Value

Requested Data Address

Address of the requested data

/data/query

Request Method

Request method. The value can be GET or POST.

GET

Request Body

This parameter is available when Request Method is POST.

The request body is in JSON format.

Yes

{"namePrefix":"test"}

Records Obtained Each Time

Number of data records obtained each time

1000

Page Size Parameter Name

Name of the page size parameter. By default, this parameter is placed in the query parameter. If the parameter name is set to page_size, it can also be obtained using #page_size.

page_size

Page Number

Name of the pagination parameter. By default, this parameter is placed in the query parameter. If the parameter name is set to page_index, it can also be obtained using #page_index.

page_index

Data Path

Location of data in JSON. The default value is the root path. If you do not set this parameter, the default value is used.

student

Data Records

Total number of data records. It can be either of the following:

  1. A fixed value, for example, 100000
  2. A value obtained from the result returned by an API, for example, page.pageCount.
NOTE:

If the API to be called is not a pagination API and the value of this parameter is less than or equal to the data obtained each time, the API will be called only once. Otherwise, the API will be called more than once and may result in repeated.

100000