Package version:

Interface RestResourceDataset

A Rest service dataset.

interface RestResourceDataset {
    additionalHeaders?: {
        [propertyName: string]: any;
    };
    annotations?: any[];
    description?: string;
    folder?: DatasetFolder;
    linkedServiceName: LinkedServiceReference;
    paginationRules?: {
        [propertyName: string]: any;
    };
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    relativeUrl?: any;
    requestBody?: any;
    requestMethod?: any;
    schema?: any;
    structure?: any;
    type: "RestResource";
}

Hierarchy (view full)

Properties

additionalHeaders? annotations? description? folder? linkedServiceName paginationRules? parameters? relativeUrl? requestBody? requestMethod? schema? structure? type

Properties

OptionaladditionalHeaders

additionalHeaders?: {
    [propertyName: string]: any;
}

The additional HTTP headers in the request to the RESTful API.

Optionalannotations

annotations?: any[]

List of tags that can be used for describing the Dataset.

Optionaldescription

description?: string

Dataset description.

Optionalfolder

folder?: DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference

Linked service reference.

OptionalpaginationRules

paginationRules?: {
    [propertyName: string]: any;
}

The pagination rules to compose next page requests.

Optionalparameters

parameters?: {
    [propertyName: string]: ParameterSpecification;
}

Parameters for dataset.

OptionalrelativeUrl

relativeUrl?: any

The relative URL to the resource that the RESTful API provides. 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).

OptionalrequestMethod

requestMethod?: any

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

Optionalschema

schema?: any

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

Optionalstructure

structure?: any

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type

type

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

Settings

Member Visibility