Package version:

Interface WebActivity

Web activity.

interface WebActivity {
    authentication?: WebActivityAuthentication;
    body?: any;
    connectVia?: IntegrationRuntimeReference;
    datasets?: DatasetReference[];
    dependsOn?: ActivityDependency[];
    description?: string;
    disableCertValidation?: boolean;
    headers?: {
        [propertyName: string]: any;
    };
    httpRequestTimeout?: any;
    linkedServiceName?: LinkedServiceReference;
    linkedServices?: LinkedServiceReference[];
    method: string;
    name: string;
    onInactiveMarkAs?: string;
    policy?: ActivityPolicy;
    state?: string;
    turnOffAsync?: boolean;
    type: "WebActivity";
    url: any;
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

authentication? body? connectVia? datasets? dependsOn? description? disableCertValidation? headers? httpRequestTimeout? linkedServiceName? linkedServices? method name onInactiveMarkAs? policy? state? turnOffAsync? type url userProperties?

Properties

Optionalauthentication

authentication?: WebActivityAuthentication

Authentication method used for calling the endpoint.

Optionalbody

body?: any

Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

Optionaldatasets

datasets?: DatasetReference[]

List of datasets passed to web endpoint.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionaldisableCertValidation

disableCertValidation?: boolean

When set to true, Certificate validation will be disabled.

Optionalheaders

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

Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).

OptionalhttpRequestTimeout

httpRequestTimeout?: any

Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

OptionallinkedServices

linkedServices?: LinkedServiceReference[]

List of linked services passed to web endpoint.

method

method: string

Rest API method for target endpoint.

name

name: string

Activity name.

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

Optionalpolicy

policy?: ActivityPolicy

Activity policy.

Optionalstate

state?: string

Activity state. This is an optional property and if not provided, the state will be Active by default.

OptionalturnOffAsync

turnOffAsync?: boolean

Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers.

type

type

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

url

url: any

Web activity target endpoint and path. Type: string (or Expression with resultType string).

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility