Package version:

Interface RestSource

A copy activity Rest service source.

interface RestSource {
    additionalColumns?: any;
    additionalHeaders?: any;
    disableMetricsCollection?: any;
    httpRequestTimeout?: any;
    maxConcurrentConnections?: any;
    paginationRules?: any;
    requestBody?: any;
    requestInterval?: any;
    requestMethod?: any;
    sourceRetryCount?: any;
    sourceRetryWait?: any;
    type: "RestSource";
}

Hierarchy (view full)

Properties

additionalColumns? additionalHeaders? disableMetricsCollection? httpRequestTimeout? maxConcurrentConnections? paginationRules? requestBody? requestInterval? requestMethod? sourceRetryCount? sourceRetryWait? type

Properties

OptionaladditionalColumns

additionalColumns?: any

Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type).

OptionaladditionalHeaders

additionalHeaders?: any

The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

OptionaldisableMetricsCollection

disableMetricsCollection?: any

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

OptionalhttpRequestTimeout

httpRequestTimeout?: any

The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

OptionalmaxConcurrentConnections

maxConcurrentConnections?: any

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

OptionalpaginationRules

paginationRules?: any

The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

OptionalrequestBody

requestBody?: any

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

OptionalrequestInterval

requestInterval?: any

The time to await before sending next page request.

OptionalrequestMethod

requestMethod?: any

The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

OptionalsourceRetryCount

sourceRetryCount?: any

Source retry count. Type: integer (or Expression with resultType integer).

OptionalsourceRetryWait

sourceRetryWait?: any

Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

type

type

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility