Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RestResourceDataset

Package version

A Rest service dataset.

Hierarchy

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional additionalHeaders

additionalHeaders: any

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

Optional annotations

annotations: any[]

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

Optional description

description: undefined | string

Dataset description.

Optional folder

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

linkedServiceName

linkedServiceName: LinkedServiceReference

Linked service reference.

Optional paginationRules

paginationRules: any

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

Optional parameters

parameters: undefined | {}

Parameters for dataset.

Optional relativeUrl

relativeUrl: any

The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).

Optional requestBody

requestBody: any

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

Optional requestMethod

requestMethod: any

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

Optional schema

schema: any

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

Optional structure

structure: any

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

type

type: "RestResource"

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

Generated using TypeDoc