Integration.Execute

Prev Next

Type

Read/write

Author

Availability

Data provider

Read

Finbourne

Provided with LUSID

The Integration.Execute provider enables you to write a Luminesce SQL query that kicks off a run of an integration instance in LUSID.

Note: The LUSID user running the query must have sufficient access control permissions to both use the provider and run integration instances. This should automatically be the case if you are the domain owner.

See also: Integration.Dashboard, Integration.Run, Integration.Log

Basic usage

select * from Integration.Execute where <filter-expression>;

Data fields

By default, Integration.Execute returns a table of data populated with particular fields (columns). You can return a subset of these fields.

To list fields available to return, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a suitable tool:

select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Integration.Execute' and FieldType = 'Column';

Note: Fields marked 'main' are returned by queries that include a caret character, for example select ^ from Integration.Execute.

Examples

Note: For more example Luminesce SQL queries, visit our Github repo.

Example 1: Kick off a run of a particular integration instance

select * from Integration.Execute where InstanceId = 'bdaeec33-228f-4842-b740-4338552f30e6'

Example 2: Kick off a run of an integration instance and return any errors

select ErrorMessage from Integration.Execute 
where InstanceId = 'bdaeec33-228f-4842-b740-4338552f30e6'
  and ErrorMessage is not null