Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TaskSummaryFromRestTask

The information about the Generic REST task. The endpoint and cancelEndpoint properties are deprecated, use the properties executeRestCallConfig, cancelRestCallConfig and pollRestCallConfig for execute, cancel and polling of the calls.

Properties

Optional apiCallMode

apiCallMode: ApiCallMode

The REST invocation pattern to use. ASYNC_OCI_WORKREQUEST is being deprecated as well as cancelEndpoint/MethodType.

Optional authConfig

authConfig: model.ResourcePrincipalAuthConfig

Optional authDetails

authDetails: model.AuthDetails

Optional cancelEndpoint

cancelEndpoint: model.Expression

Optional cancelMethodType

cancelMethodType: CancelMethodType

The REST method to use for canceling the original request.

Optional cancelRestCallConfig

cancelRestCallConfig: model.CancelRestCallConfig

Optional configProviderDelegate

configProviderDelegate: model.ConfigProvider

Optional description

description: undefined | string

Detailed description for the object.

Optional endpoint

endpoint: model.Expression

Optional executeRestCallConfig

executeRestCallConfig: model.ExecuteRestCallConfig

Optional headers

headers: any

Headers for payload.

Optional identifier

identifier: undefined | string

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional inputPorts

inputPorts: Array<InputPort>

An array of input ports.

Optional isConcurrentAllowed

isConcurrentAllowed: undefined | false | true

Whether the same task can be executed concurrently.

Optional jsonData

jsonData: undefined | string

JSON data for payload body. This property is deprecated, use ExecuteRestCallConfig's payload config param instead.

Optional key

key: undefined | string

Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create.

Optional keyMap

keyMap: undefined | object

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Optional metadata

metadata: model.ObjectMetadata

Optional methodType

methodType: MethodType

The REST method to use. This property is deprecated, use ExecuteRestCallConfig's methodType property instead.

Const modelType

modelType: string = "REST_TASK"

Optional modelVersion

modelVersion: undefined | string

The object's model version.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional objectVersion

objectVersion: undefined | number

The version of the object that is used to track changes in the object instance. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional opConfigValues

opConfigValues: model.ConfigValues

Optional outputPorts

outputPorts: Array<OutputPort>

An array of output ports.

Optional parameters

parameters: Array<Parameter>

An array of parameters.

Optional parentRef

parentRef: model.ParentReference

Optional pollRestCallConfig

pollRestCallConfig: model.PollRestCallConfig

Methods

getDeserializedJsonObj

getJsonObj