Console
React Lib
REST API
Preparing search index...
The search index is not available
Integration App SDK - v1.11.4
Integration App SDK
getFlowNodeDescription
Function getFlowNodeDescription
get
Flow
Node
Description
(
flow
,
nodeKey
)
:
string
|
undefined
Parameters
flow
:
FlowInstance
|
Flow
nodeKey
:
string
Returns
string
|
undefined
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Console
React Lib
REST API
Integration App SDK - v1.11.4
BaseElementInstance
ElementInstanceSelector
IntegrationSpecificElementSelector
ElementAccessor
ElementListAccessor
ElementInstanceListAccessor
ElementInstanceAccessor
ActionsAccessor
ActionAccessor
ActionInstancesAccessor
ActionInstanceAccessor
IntegrationLevelActionAccessor
IntegrationLevelActionsListAccessor
ConnectionLevelActionAccessor
ConnectionLevelActionsAccessor
ActionType
ActionSpec
isDataActionType
ACTIONS
ActionDependencyType
ActionDependency
Action
ActionInstance
ListActionsForIntegrationQuery
FindActionsQuery
CreateActionRequest
UpdateActionRequest
ActionSelector
ActionInstanceSelector
ListActionInstancesForConnectionQuery
FindActionInstancesQuery
CreateActionInstanceRequest
UpdateActionInstanceRequest
OpenActionConfigurationOptions
ActionRunResponse
AppDataSchemasAccessor
AppDataSchemaAccessor
AppDataSchemaInstancesAccessor
AppDataSchemaInstanceAccessor
CreateAppDataSchemaRequest
UpdateAppDataSchemaRequest
FindAppDataSchemasQuery
AppDataSchemaInstanceSelector
UpdateAppDataSchemaInstanceRequest
CreateAppDataSchemaInstanceRequest
FindAppDataSchemaInstancesQuery
AppDataSchema
AppDataSchemaInstance
AppEventTypesAccessor
AppEventTypeAccessor
AppEventSubscriptionsAccessor
AppEventSubscriptionAccessor
AppEventsAccessor
UpdateAppEventTypeRequest
CreateAppEventTypeRequest
AppEventSubscriptionSelector
AppEventSubscriptionCreateRequest
AppEventSubscriptionUpdateRequest
FindAppEventTypesQuery
FindAppEventSubscriptionsQuery
FindAppEventsQuery
AppEventType
AppEventSubscription
AppEvent
App
AppCategory
SelfAccessor
Self
IntegrationAppClient
ConnectionsAccessor
ConnectionAccessor
ConnectionOperationAccessor
ConnectionDataDirectoryAccessor
ConnectionDataCollectionAccessor
ConnectionProxy
FindConnectionsQuery
CreateConnectionRequest
UpdateConnectionRequest
FindConnectionsResponse
ConnectionSelector
ConnectionRequest
Connection
ConnectionSpec
ConnectionUiSpec
ConnectionUdmSpec
ConnectionDataSpec
ConnectorCopilotSuggestionType
ConnectorCopilotSuggestion
ConnectorCopilotSuggestionAction
ConnectorCopilotFileChunkTopicKey
CopilotTaskType
CopilotTaskStatus
CopilotTask
CopilotActionType
CopilotActionStatus
CopilotAction
CopilotActivityType
CopilotActivityDataTask
CopilotActivity
CopilotActionReference
CopilotActivityScope
CONNECTOR_AUTH_TYPES
ConnectorAuthType
ConnectorAuthSpec
ConnectorAuthHandlerBase
ConnectorAuthMethodTypes
ConnectorAuthOAuth2
ConnectorAuthOAuth1
ConnectorAuthClientCredentials
ConnectorAuthProxy
ConnectorAuthIntegrationAppToken
ConnectorAuth
ConnectorAuthOAuth2Config
ConnectorAuthOAuthConfig
ConnectorAuthOAuth1Config
OAUTH_CONFIG_SCHEMA
OAUTH1_CONFIG_SCHEMA
CONNECTOR_DATA_DIR
CONNECTOR_OPERATIONS_DIR
CONNECTOR_DOCS_DIR
CONNECTOR_GLOBAL_WEBHOOKS_DIR
CONNECTOR_EVENTS_DIR
ConnectorDataLocationBase
PullLatestRecordsEventOutput
ConnectorDataCollectionEvent
ConnectorDataCollectionEventWebhook
ConnectorDataCollectionEventPullLatestRecords
ConnectorDataCollectionEventCustomPull
ConnectorDataCollectionEventFullScan
ConnectorDataCollectionEventImplementationType
ConnectorDataCollectionEventType
ConnectorDataCollectionEventImplementationTypeKey
getEventMethodFileKey
getAllEventMethodFilePaths
DataLocationTypeCollection
ConnectorDataCollection
ConnectorDataCollectionMethodKeys
DataLocationTypeDirectory
ConnectorDataDirectory
ConnectorDataDirectoryMethodKeys
ConnectorDataLocationMethod
DataLocationMethodImplementationTypes
DataLocationSpec
DataLocationType
DataLocationListItem
DataLocationPointer
DataLocation
DataLocationMixin
DataCollectionSpec
ApiRequestSpec
DataDirectoryOperation
DataDirectorySpec
DataCollectionMethodSpec
DataCollectionFindSpec
DataCollectionMatchSpec
DataCollectionListSpec
DataCollectionSearchSpec
DataCollectionFindByIdSpec
DataCollectionCreateSpec
DataCollectionUpdateSpec
DataCollectionDeleteSpec
DataCollectionUdmSpec
DataCollectionUdmsSpec
DataCollectionEventTypeSpec
DataCollectionEventsSpec
DataCollectionMethodRequest
DataCollectionFindRequest
DataCollectionFindResponse
DataCollectionListRequest
DataCollectionListResponseDrilldown
DataCollectionListResponse
DataCollectionSearchRequest
DataCollectionSearchResponse
DataCollectionFindByIdRequest
DataCollectionFindByIdResponse
DataCollectionMatchRequest
DataCollectionMatchResponse
DataCollectionCreateRequest
DataCollectionCreateResponse
DataCollectionUpdateRequest
DataCollectionUpdateResponse
DataCollectionDeleteRequest
DataCollectionDeleteResponse
DataCollectionSubscribeRequest
DataCollectionSubscribeResponse
DataCollectionUpdateSubscriptionRequest
DataCollectionUpdateSubscriptionResponse
DataCollectionUnsubscribeRequest
DataCollectionUnsubscribeResponse
DataCollectionEventsRequest
DataCollectionEventsResponse
DataEventWebhookPayload
DataCollectionParseUnifiedFieldsRequest
DataCollectionParseUnifiedFieldsResponse
DataDirectoryListRequest
DataDirectoryListResponse
ConnectorDataLocationTypes
ConnectorDataLocation
getDataLocationMethodPath
dataLocationParametersMatch
parseDataLocationPath
makeDataLocationPath
makeDataLocationOperationPath
isSameDataLocation
isDataLocationMethodSupported
getDataCollectionCreateFields
getDataCollectionUpdateFields
getWritableFieldsSchema
DATA_RECORD_SCHEMA
makeDataRecordSchema
ConnectorEventImplementationType
ConnectorEventHandlerMethods
ConnectorEventHandler
ConnectorEventSpec
ConnectorEventListItem
ConnectorEventGlobalWebhookGetEventSelectorResponse
ConnectorGlobalWebhookHandler
ConnectorGlobalWebhookSpec
ConnectorGlobalWebhookHandleRequest
ConnectorGlobalWebhookHandleResponse
ConnectorGlobalWebhookListItem
GraphqlApiClientInput
GraphQLApiMapping
GraphQLFieldMapping
ConnectorMethodImplementationType
ConnectorMethodImplementation
CONNECTOR_METHOD_IMPLEMENTATION_SUFFIXES
ConnectorMethodImplementationBase
ConnectorMethodImplementationMapping
ConnectorMethodImplementationOperationMapping
ConnectorMethodImplementationRestApiMapping
ConnectorMethodImplementationGraphqlApiMapping
ConnectorMethodImplementationJavascript
ConnectorMethodImplementationNotSupported
OpenapiMapping
ConnectorOperationMethod
ConnectorOperationMethodImplementationTypes
ConnectorOperationHandler
OperationListItem
OperationSpec
OperationRunRequest
OperationRunResponse
OperationMapping
RestApiClientInput
RestApiClientOutput
RestApiMapping
RestApiClientResponseHandler
RestApiClientOverride
RestApiClientOptions
CONNECTOR_CATEGORIES
Connector
ConnectorStatus
ConnectorUiSpec
ConnectorDataUdmSpec
ConnectorDataSpec
ConnectorApiType
ConnectorSpec
MinimalConnector
ConnectorUdmListLitem
ConnectorUdmSpec
ConnectorUdmCollectionMapping
findUdmCollectionMapping
buildData
resolveFormulas
resolveValue
valueToString
processValue
processCopy
getVariableLocators
transformVars
removeNonExistentVars
getValueByLocator
isFormula
hasFormulas
getFormula
CaseFormulaValueItem
CaseFormulaValue
EvalOperator
Formula
And
Base
Case
Concat
Copy
DataSchemaRef
DomainFromEmail
Eval
ExtractDate
ExtractTime
FindAppRecordId
FindExternalRecordId
FirstName
FirstNotEmpty
Formula
Iterate
Jsonata
LastName
Lookup
Map
MergeObjects
Or
Plain
Record
Tpl
Var
LookupValue
MappingItem
DataBuilderFormulaType
DataLocatorStepType
DataLocatorStep
DataLocatorStepObjectProperty
DataLocatorStepArrayItem
DataLocator
InvalidLocatorError
locatorToField
makeObjectPropertyLocator
getLocatorsFromSchema
getSchemaByLocator
findValueLocators
getValueAtLocator
setValueAtLocator
pickFieldsFromValue
excludeFieldsFromValue
setSchemaAtLocator
extractFieldLocator
makeSchemaForLocator
getNameForLocator
getNameComponentsForLocator
getFullNameForLocator
getIconUriForLocator
getLocatorsFromData
getFullTitleForLocator
isValidLocator
locatorToSteps
locatorToString
stepsToLocator
createObjectFromLocators
getFormulaLocators
transformVariablesWith
DataRecord
DataCollectionEventType
DataCollectionEvent
backwardCompatibleFilterMatch
doesMatchFilter
DataFilterCondition
DataFilter
getOperatorsBySchema
getFilterFieldValuesByLocator
DataFormArgs
FieldValueOption
DataForm
DataLinkTablesAccessor
DataLinkTableAccessor
DataLinkTableInstancesAccessor
DataLinkTableInstanceAccessor
CreateDataLinkTableRequest
UpdateDataLinkTableRequest
FindDataLinkTablesQuery
FindDataLinkTableInstancesQuery
DataLinkTableInstanceSelector
UpdateDataLinkTableInstanceRequest
CreateDataLinkTableInstanceRequest
FindDataLinksInTableQuery
CreateDataLinkRequest
DeleteDataLinkRequest
FindDataLinksQuery
FindDataLinksResponse
FindDataLinkQuery
DataLinkInTableSelector
DataLinkSelector
DataLinkDirection
DataLinkTable
DataLinkTableInstance
DataLink
DataLinkTableConfig
createSchema
createCompoundSchema
IDataField
DataField
PatchSchemaOption
mergeSchemas
patchSchema
unwrapSchema
unwrapSchemas
wrapAnyOfSchema
DataSchema
buildDataSchema
updateImpliedSchema
schemaHasProperties
nonEmptyObjectProperties
getSchemaFromValue
schemaTypeFromValue
ValueToSchemaOptions
valueToSchema
schemaIsScalar
schemaHasFixedValues
schemaAllowsCustomValue
schemaIsNumber
schemaWithTitle
pickFieldsFromSchema
excludeReadOnlyFieldsFromSchema
excludeWriteOnlyFieldsFromSchema
excludeFieldsFromSchema
getRequiredFieldsFromSchema
addRequiredFieldsToSchema
removeRequiredFieldsFromSchema
getMissingRequiredFields
populateSchemaTitles
generateExampleFromSchema
isSchemaEmpty
compressDataSchema
getReferenceCollectionPointerForSchema
getReferenceCollectionPathForSchema
walkSchema
OpenDataSourceConfigurationOptions
DataSourcesAccessor
DataSourceAccessor
DataSourceInstancesAccessor
DataSourceInstanceAccessor
IntegrationLevelDataSourceAccessor
IntegrationLevelDataSourcesListAccessor
ConnectionLevelDataSourceAccessor
ConnectionLevelDataSourcesAccessor
ListDataSourcesForIntegrationQuery
FindDataSourcesQuery
CreateDataSourceRequest
UpdateDataSourceRequest
DataSourceInstanceSelector
FindDataSourceInstancesQuery
FindDataSourceInstancesResponse
CreateDataSourceInstanceRequest
UpdateDataSourceInstanceRequest
FindDataSourceEventsQuery
FindDataSourceSyncsQuery
ListDataSourceInstancesForConnectionQuery
FindDataSourceInstanceSyncsQuery
DEFAULT_PULL_UPDATES_INTERVAL_SECONDS
DEFAULT_FULL_SYNC_INTERVAL_SECONDS
MIN_FULL_SYNC_INTERVAL_SECONDS
MIN_PULL_UPDATES_INTERVAL_SECONDS
DataSourceUnitConfig
DataSource
DataSourceInstance
DataSourceSelector
parseDate
CommonListElementsQuery
CommonInstancesListQuery
CommonIntegrationOrConnectionQuery
IncludeArchivedQuery
SearchQuery
PaginationQuery
PaginationResponse
ErrorDoc
ErrorType
BadRequestErrorKey
ConnectionErrorKey
ConcurrencyErrorKey
isIntegrationAppError
ErrorData
IntegrationAppError
InternalError
BadRequestError
ConcurrencyError
ConfigurationError
DependencyError
FlowInstanceSetupError
FlowRunError
ActionRunError
ActionInstanceSetupError
UnitRunError
ConnectionError
NotFoundError
RateLimitExceededError
NotAuthenticatedError
AccessDeniedError
CustomCodeError
getErrorFromData
extractIntegrationAppErrorData
buildUserFriendlyErrorMessage
ExternalEventSubscriptionsAccessor
ExternalEventSubscriptionAccessor
FindExternalEventSubscriptionsQuery
FindExternalEventLogsQuery
FindExternalEventPullsQuery
externalEventTypeToDataCollectionEventType
dataCollectionEventTypeToExternalEventType
externalEventTypeToSubscriptionType
ExternalEventType
ExternalEventSubscriptionStatus
ExternalEventPullStatus
IncomingWebhooksState
ExternalEventUnitConfig
ExternalEventSubscriptionType
ExternalEventSubscriptionConfig
ExternalEvent
ExternalEventSubscription
ExternalEventLogStatus
ExternalEventLogRecord
ExternalEventCustomPullSubscribeResponse
ExternalEventCustomPullCollectEventsRequest
ExternalEventCustomPullCollectEventsResponse
ExternalEventWebhookSubscribeRequest
ExternalEventWebhookSubscribeResponse
ExternalEventWebhookUnsubscribeRequest
ExternalEventWebhookHandleRequest
ExternalEventWebhookHandleResponse
ExternalEventWebhookRefreshRequest
ExternalEventWebhookRefreshResponse
ExternalEventPull
OpenFieldMappingInstanceConfigurationOptions
FieldMappingsAccessor
FieldMappingAccessor
FieldMappingInstancesAccessor
FieldMappingInstanceAccessor
IntegrationLevelFieldMappingAccessor
IntegrationLevelFieldMappingsListAccessor
ConnectionLevelFieldMappingAccessor
ConnectionLevelFieldMappingsAccessor
ListFieldMappingsForIntegrationQuery
FindFieldMappingsQuery
ListFieldMappingInstancesForConnectionQuery
FindFieldMappingInstancesQuery
UpdateFieldMappingRequest
CreateFieldMappingRequest
CreateFieldMappingInstanceRequest
UpdateFieldMappingInstanceRequest
FieldMappingInstanceSelector
FieldMappingSelector
FieldMappingDirection
FieldMapping
FieldMappingInstance
mergeWithFormulas
isObject
FieldMappingUnitConfig
FlowRunsAccessor
FlowRunAccessor
FlowNodeRunStatus
FlowNodeHandlerRunResponse
UpstreamFlowNodeRun
DownstreamFlowNodeRun
FlowNodeRunParameters
FlowNodeRunOutput
FlowNodeRunResult
FlowNodeRunRecord
FlowNodeRunRecordWithoutOutputsData
FlowNodeRunOutputWithoutDownstreamRuns
FlowRunState
FlowRunNodeState
FlowRunLaunchedByTrigger
FlowRun
FlowRunNode
FlowRunLaunchedBy
CreateFlowRunRequest
FindFlowRunsQuery
FindFlowRunsResponse
OpenFlowInstanceConfigurationOptions
OpenFlowInstanceEditorOptions
FlowsAccessor
FlowAccessor
FlowInstancesAccessor
FlowInstanceAccessor
IntegrationLevelFlowAccessor
IntegrationLevelFlowsListAccessor
ConnectionLevelFlowAccessor
ConnectionLevelFlowsAccessor
ListFlowsForIntegrationQuery
FindFlowsQuery
CreateFlowNodeRequest
CreateFlowRequest
UpdateFlowRequest
FlowSelector
ListFlowInstancesForConnectionQuery
FindFlowInstancesQuery
FlowInstanceSelector
ResetFlowInstanceOptions
RunFlowOptions
FlowNodeSpec
FlowNodeType
FLOW_NODE_SPECS
createFlowInstanceSchema
updateFlowInstanceSchema
CreateFlowInstanceRequest
UpdateFlowInstanceRequest
FlowNode
Flow
FlowInstance
FlowInstanceNodeState
FlowInstanceNode
FlowNodeLink
getFlowNode
getFlowNodeTitle
getFlowNodeDescription
getFlowNodeSpec
getFlowInstanceNodeDependency
getRootNodeKeys
getChildNodeKeys
getDownstreamNodeKeys
getParentNodeKeys
getUpstreamNodeKeys
hasCycles
HttpRequestMethod
HttpRequestSpec
HTTP_REQUEST_SCHEMA
IntegrationElementLevel
IntegrationElementType
ElementTemplateFields
ElementInstanceFields
IntegrationElement
IntegrationElementInstance
IntegrationElementInstanceDependency
IntegrationsAccessor
IntegrationAccessor
CreateIntegrationRequest
UpdateIntegrationRequest
FindIntegrationsQuery
FindIntegrationsResponse
OpenNewConnectionOptions
Integration
IntegrationAuthOption
AppliedToIntegrations
WithExecutionLogs
isStream
streamToString
truncateData
LogRecordType
LogRecord
OrgLimitsType
OrgLimits
Org
OrgUserRole
OrgUserStatus
PlatformUser
OrgUser
OrgWorkspace
ScenariosAccessor
ScenarioAccessor
Scenario
ScenarioToDo
ScenarioElement
FindScenariosQuery
CreateScenarioRequest
UpdateScenarioRequest
ScenarioTemplate
ScenarioTemplateCategory
FindScenarioTemplatesQuery
CreateScenarioTemplateRequest
UpdateScenarioTemplateRequest
ScenarioTemplateElementOverride
ScenarioTemplateKeyCollision
ScenarioTemplateIntegration
ScenarioTemplateElements
HandyScenarioTemplateElement
ScreensAccessor
ScreenAccessor
ScreenType
ScreenBlockType
ScreenBlock
ScreenSelector
UpdateScreenRequest
CreateScreenRequest
FindScreensQuery
Screen
UnifiedDataModel
UDM
UNIFIED_DATA_MODELS
findUdmRootLocation
findUdmDefaultCollection
addUdmFallbackFields
UsageType
UsageWithCredits
UsageEntry
CustomersAccessor
CustomerAccessor
CreateCustomerRequest
UpdateCustomerRequest
FindCustomersQuery
CustomerSelector
CreateUserRequest
UpdateUserRequest
FindUsersQuery
UserSelector
Customer
User
getNodeInputSchema
getFlowNodeConfigTimeVariablesSchema
getActionRunTimeVariablesSchema
getActionInstanceVariableSchema
getFlowNodeRunTimeVariablesSchema
WebhookTypeEnum
WebhookType
Webhook
WorkspaceElementSpec
WorkspaceElements
WorkspaceElementSpecs
ConfigurationStateResult
ConfigurationState
WorkspaceElementType
WorkspaceEventType
WorkspaceElementState
WorkspaceElementDependencyType
WorkspaceElementCalculateStateResult
WorkspaceElement
WorkspaceElementReference
WorkspaceElementDependency
WorkspaceUpdate
IWorkspaceUpdate
PARALLEL_EXECUTION_LIMITS
RATE_LIMITS
WORKSPACE_SIZE_LIMITS
EDITABLE_LIMITS
WorkspaceOnboardingStep
Workspace
EngineWorkspaceSettings
EngineWorkspace
WorkspaceUser
UserWorkspaceSettings
WorkspaceNotificationType
WorkspaceNotification
CopilotActivityNotificationData
ParallelExecutionLimits
RateLimits
WorkspaceSizeLimits
CustomerLimits
LimitUnits
WorkspaceLimit
WorkspaceLimits
EngineWorkspaceWithOrgData
WorkspaceType
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R