Help Center/ DataArts Studio/ User Guide/ DataArts Migration (Offline Jobs)/ Supported Data Sources/ Rest Client
Updated on 2026-05-20 GMT+08:00
View PDF
Share

Rest Client

Rest Client is a tool used to construct and send HTTP requests to interact with RESTful web services. It features high usability, flexibility, and scalability, and is widely used in data exchange and integration between different systems. DataArts Migration supports Rest Client and can access and read data from structured and semi-structured data sources, and efficiently migrate and write data to meet complex data integration requirements.

Preparation and Constraints

Network requirements

The Rest Client data source can communicate with CDM. This ensures smooth data transmission. For details, see Enabling Network Connectivity.

Supported Migration Scenarios

DataArts Migration supports the following modes for synchronizing on-premises data:

  • Single table synchronization

    DataArts Migration supports table/file synchronization in data ingestion into a data lake or data migration to the cloud.

  • Database and table shard synchronization

    DataArts Migration supports synchronization of data from multiple databases and tables in data ingestion into a data lake or data migration to the cloud.

  • Entire DB migration

    DataArts Migrations supports synchronization of data from an on-premises database in data ingestion into a data lake or data migration to the cloud.

Database and table shard synchronization and entire DB migration are not supported in all regions. The following table lists the supported Rest Client migration scenarios.

Supported Migration Scenario

Single Table Read

Single Table Write

Database/Table Shard Read

Database/Table Shard Write

Entire DB Read

Entire DB Write

Supported

√

x

x

x

x

x

Core Capabilities

  • Connection configuration

    Configuration Item

    Supported

    Description

    Supported request types

    GET

    POST

    Two most common HTTP request types are supported.

    Authentication types

    NONE

    BASIC_AUTH

    TOKEN_AUTH

    OAUTH_CODE_GRANT
    • NONE: no authentication
    • BASIC_AUTH: basic authentication

      If the data source API supports username and password authentication, you can select this authentication type and configure the username and password used for authentication. When the data source is connected, the username and password are transferred to the RESTful address through the Basic Auth protocol for authentication. The format is {"Authorization":"Basic base64(username:password)"}.

    • TOKEN_AUTH: token authentication (The token is static and never expires. Otherwise, jobs will fail if the token expires.)

      If the data source API supports token-based authentication., you can select this authentication type and set a fixed token for authentication. When the data source is connected, the token is transferred to the header for authentication. The format is {"Authorization":"Bearer <token>"}.

    • OAUTH_CODE_GRANT Oauth 2.0 (Authorization Code): Oauth2.0 authentication

      In this mode, a username and a password are used to obtain an access token, which is used to access APIs.
  • Read capabilities

    Configuration Item

    Supported

    Description

    Incremental read

    √

    The URL or body can be modified to enable incremental read.

    Concurrent read

    √

    Horizontal sharding based on pages and multi-thread concurrent extraction significantly improve the throughput and efficiency.

    Nested JSON parsing

    √

    The JSON data structure in the response body can be parsed. JSON data with multiple layers of nested fields can be correctly processed, ensuring data integrity and accuracy.

Creating a Data Source

Create a data source in Management Center. For details, see Configuring Data Connection Parameters.

Creating an Offline Data Migration Job

Create a Rest Client migration job in DataArts Factory. For details, see Creating an Offline Processing Migration Job.

Parent topic: Supported Data Sources