From RestApi

Updated on 2024-10-28 GMT+08:00

View PDF

**Table 1** Parameter description
Type	Parameter	Description	Mandatory	Example Value
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 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	Yes	1000
	Page Size	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	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.	No	data.students
	Data Records	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

Parent topic: Configuring Source Job Parameters

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.