Type | Read/write | Author | Availability |
Data provider | Read | FINBOURNE | Provided with LUSID |
Providing you have sufficient access control permissions, the Notification.Subscription.NotificationConfiguration
provider enables you to write a Luminesce SQL query that retrieves email, SMS, Amazon SQS and webhook notifications set up for event subscriptions stored in LUSID's Notification Service.
See also: Notification.Subscription
Basic usage
select * from Notification.Subscription.NotificationConfiguration where <filter-expression>
Query parameters
Notification.Subscription.NotificationConfiguration
has parameters that enable you to filter or refine a query.
To list available parameters, their data types, default values, and an explanation for each, run the following query using a suitable tool:
select FieldName, DataType, ParamDefaultValue, Description from Sys.Field where TableName = 'Notification.Subscription.NotificationConfiguration' and FieldType = 'Parameter';
Data fields
By default, Notification.Subscription.NotificationConfiguration
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 = 'Notification.Subscription.NotificationConfiguration' and FieldType = 'Column';
Note: Fields marked 'main' are returned by queries that select a caret character, for example select ^ from Notification.Subscription.NotificationConfiguration
.
Examples
Note: For more example Luminesce SQL queries, visit our Github repo.
Example 1: Retrieve first ten notifications set up for event subscriptions
select * from Notification.Subscription.NotificationConfiguration limit 10;
Example 2: Retrieve a particular notification set up for an event subscription
select * from Notification.Subscription.NotificationConfiguration where Id = 'PortfolioCreatedNotification';
Example 3: Retrieve all email notifications set up for event subscriptions
select * from Notification.Subscription.NotificationConfiguration where Type = 'Email';
Example 4: Retrieve all notifications set up for a particular event subscription
select * from Notification.Subscription.NotificationConfiguration where Scope = 'PortfolioEvents' and Code = 'PortfolioCreatedEvent';