Parameter | Description | Required | Default value |
url | The URL of the RESTful API. | Yes | No default value |
dataMode | The method that RestAPI Reader uses to read data from the JSON-formatted response returned by the RESTful API. Valid values: | Yes | No default value |
responseType | The format of the response returned by the RESTful API. Only the JSON format is supported. | Yes | JSON |
column | The names of the fields from which you want to read data. The type parameter specifies the data type of a field. The name parameter specifies the JSON-formatted path in which the field is located. You can configure the column parameter in the following format: "column":[{"type":"long","name":"a.b" // Query data in the a.b path.},{"type":"string","name":"a.c"// Query data in the a.c path.}] You must configure the type and name parameters for each field. | Yes | No default value |
dataPath | The path of the JSON-formatted data record or JSON array that is queried. | No | No default value |
method | The request method. Valid values: get and post. | Yes | No default value |
customHeader | The header information transferred to the RESTful API. | No | No default value |
parameters | The parameter information transferred to the RESTful API. If the method parameter is set to get, set the value to abc=1&def=1 . If the method parameter is set to post, configure JSON parameters.
| No | No default value |
dirtyData | The processing mechanism that is used when no data is found in the JSON-formatted path specified by using the column parameter. Valid values: dirty: If a specific data record cannot be found in the specified JSON-formatted path, this data record is considered as a dirty data record. null: If a specific data record cannot be found in the specified JSON-formatted path, the column parameter is set to null.
| Yes | dirty |
requestTimes | The number of times RestAPI Reader requests to read data from the response returned by the RESTful API. Valid values: single: only once multiple: multiple times
| Yes | single |
requestParam | If you set the requestTimes parameter to multiple, you must configure a parameter that you want to repeatedly pass to the RESTful API in each request. For example, if you configure the pageNumber parameter, RestAPI Reader passes the pageNumber parameter to the RESTful API based on the settings of the startIndex, endIndex, and step parameters. | No | No default value |
startIndex | The start point of requests. The data at the start point is also requested. | No | No default value |
endIndex | The end point of requests. The data at the end point is also requested. | No | No default value |
step | The step at which requests are sent. | No | No default value |
authType | The authentication method. Valid values: - Basic Auth: basic authentication
If the data source supports username- and password-based authentication, you can select Basic Auth and configure the username and password that can be used for authentication. During data integration, the username and password are transferred to the RESTful API URL for authentication. The data source is connected only after the authentication is successful. - Token Auth: token-based authentication
If the data source supports token-based authentication, you can select Token Auth and configure a fixed token value that can be used for authentication. During data integration, the token is contained in the request header, such as {"Authorization":"Bearer TokenXXXXXX"}, and transferred to the RESTful API URL for authentication. The data source is connected only after the authentication is successful. - Aliyun API Signature: Alibaba Cloud API signature-based authentication
If the following conditions are met, you can select Aliyun API Signature and configure the AccessKey ID and AccessKey secret that can be used for authentication: The data source that you want to connect is an Alibaba Cloud service, and the API of this service supports AccessKey pair-based authentication.
| No | No default value |
authUsername/authPassword | The username and password used for basic authentication. | No | No default value |
authToken | The token used for token-based authentication. | No | No default value |
accessKey/accessSecret | The AccessKey pair used for authentication based on Alibaba Cloud API signature. | No | No default value |