Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.ICheckDefinitionsApiSync:

[legend]

Public Member Functions
CheckDefinition	CreateCheckDefinition (CreateCheckDefinitionRequest? createCheckDefinitionRequest=default(CreateCheckDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition More...

Lusid.Sdk.Client.ApiResponse< CheckDefinition >	CreateCheckDefinitionWithHttpInfo (CreateCheckDefinitionRequest? createCheckDefinitionRequest=default(CreateCheckDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition More...

DeletedEntityResponse	DeleteCheckDefinition (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteCheckDefinitionWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition More...

CheckDefinition	DeleteRules (string scope, string code, List< DeleteDataQualityRule >? deleteDataQualityRule=default(List< DeleteDataQualityRule >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition More...

Lusid.Sdk.Client.ApiResponse< CheckDefinition >	DeleteRulesWithHttpInfo (string scope, string code, List< DeleteDataQualityRule >? deleteDataQualityRule=default(List< DeleteDataQualityRule >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition More...

CheckDefinition	GetCheckDefinition (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code. More...

Lusid.Sdk.Client.ApiResponse< CheckDefinition >	GetCheckDefinitionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code. More...

PagedResourceListOfCheckDefinition	ListCheckDefinitions (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCheckDefinition >	ListCheckDefinitionsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions More...

RunCheckResponse	RunCheckDefinition (string scope, string code, RunCheckRequest? runCheckRequest=default(RunCheckRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset. More...

Lusid.Sdk.Client.ApiResponse< RunCheckResponse >	RunCheckDefinitionWithHttpInfo (string scope, string code, RunCheckRequest? runCheckRequest=default(RunCheckRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset. More...

CheckDefinition	UpdateCheckDefinition (string scope, string code, UpdateCheckDefinitionRequest? updateCheckDefinitionRequest=default(UpdateCheckDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code More...

Lusid.Sdk.Client.ApiResponse< CheckDefinition >	UpdateCheckDefinitionWithHttpInfo (string scope, string code, UpdateCheckDefinitionRequest? updateCheckDefinitionRequest=default(UpdateCheckDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code More...

CheckDefinition	UpsertRules (string scope, string code, List< UpsertDataQualityRule >? upsertDataQualityRule=default(List< UpsertDataQualityRule >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition More...

Lusid.Sdk.Client.ApiResponse< CheckDefinition >	UpsertRulesWithHttpInfo (string scope, string code, List< UpsertDataQualityRule >? upsertDataQualityRule=default(List< UpsertDataQualityRule >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateCheckDefinition()

CheckDefinition Lusid.Sdk.Api.ICheckDefinitionsApiSync.CreateCheckDefinition	(	CreateCheckDefinitionRequest?	createCheckDefinitionRequest = `default(CreateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition

Creates a Check Definition. Returns the created Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createCheckDefinitionRequest	The request containing the details of the Check Definition (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ CreateCheckDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CheckDefinition> Lusid.Sdk.Api.ICheckDefinitionsApiSync.CreateCheckDefinitionWithHttpInfo	(	CreateCheckDefinitionRequest?	createCheckDefinitionRequest = `default(CreateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition

Creates a Check Definition. Returns the created Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createCheckDefinitionRequest	The request containing the details of the Check Definition (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ DeleteCheckDefinition()

DeletedEntityResponse Lusid.Sdk.Api.ICheckDefinitionsApiSync.DeleteCheckDefinition	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition

The deletion will take effect from the Check Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ DeleteCheckDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ICheckDefinitionsApiSync.DeleteCheckDefinitionWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition

The deletion will take effect from the Check Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ DeleteRules()

CheckDefinition Lusid.Sdk.Api.ICheckDefinitionsApiSync.DeleteRules	(	string	scope,
		string	code,
		List< DeleteDataQualityRule >?	deleteDataQualityRule = `default(List< DeleteDataQualityRule >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition

Delete rules for a given check definition. This will not affect any other rules that are not included in the request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
deleteDataQualityRule	The request containing the rules to be deleted (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ DeleteRulesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CheckDefinition> Lusid.Sdk.Api.ICheckDefinitionsApiSync.DeleteRulesWithHttpInfo	(	string	scope,
		string	code,
		List< DeleteDataQualityRule >?	deleteDataQualityRule = `default(List< DeleteDataQualityRule >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition

Delete rules for a given check definition. This will not affect any other rules that are not included in the request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
deleteDataQualityRule	The request containing the rules to be deleted (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ GetCheckDefinition()

CheckDefinition Lusid.Sdk.Api.ICheckDefinitionsApiSync.GetCheckDefinition	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code.

Retrieves one Check Definition by scope and code. Check Definitions are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the scope this uniquely identifies the Check Definition.
asAt	The asAt datetime at which to retrieve the Check Definition definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the check definition properties. Defaults to the current LUSID system datetime if not specified. (optional)
propertyKeys	A list of property keys from the 'CheckDefinition' domain to decorate onto the Check Definition. These must have the format {domain}/{scope}/{code}, for example 'CheckDefinition/system/Name'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ GetCheckDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CheckDefinition> Lusid.Sdk.Api.ICheckDefinitionsApiSync.GetCheckDefinitionWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code.

Retrieves one Check Definition by scope and code. Check Definitions are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the scope this uniquely identifies the Check Definition.
asAt	The asAt datetime at which to retrieve the Check Definition definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the check definition properties. Defaults to the current LUSID system datetime if not specified. (optional)
propertyKeys	A list of property keys from the 'CheckDefinition' domain to decorate onto the Check Definition. These must have the format {domain}/{scope}/{code}, for example 'CheckDefinition/system/Name'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ ListCheckDefinitions()

PagedResourceListOfCheckDefinition Lusid.Sdk.Api.ICheckDefinitionsApiSync.ListCheckDefinitions	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions

List all the Check Definitions matching a particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the Check Definitions. Defaults to returning the latest version of each Check Definition if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to list the Check Definitions. Note that Check Definitions are monotemporal, the effectiveAt is for Timevariant Properties on the Check Definition only. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue listing Check Definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the displayName, specify "displayName eq 'MyCheckDefinition'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional)
propertyKeys	A list of property keys from the 'CheckDefinition' domain to decorate onto each Check Definition. These must take the format {domain}/{scope}/{code}, for example 'CheckDefinition/Account/id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfCheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ ListCheckDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCheckDefinition> Lusid.Sdk.Api.ICheckDefinitionsApiSync.ListCheckDefinitionsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions

List all the Check Definitions matching a particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the Check Definitions. Defaults to returning the latest version of each Check Definition if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to list the Check Definitions. Note that Check Definitions are monotemporal, the effectiveAt is for Timevariant Properties on the Check Definition only. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue listing Check Definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the displayName, specify "displayName eq 'MyCheckDefinition'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional)
propertyKeys	A list of property keys from the 'CheckDefinition' domain to decorate onto each Check Definition. These must take the format {domain}/{scope}/{code}, for example 'CheckDefinition/Account/id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfCheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ RunCheckDefinition()

RunCheckResponse Lusid.Sdk.Api.ICheckDefinitionsApiSync.RunCheckDefinition	(	string	scope,
		string	code,
		RunCheckRequest?	runCheckRequest = `default(RunCheckRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.

Runs a Check Definition against given dataset.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the CheckDefinition to run.
code	Code of the CheckDefinition to run.
runCheckRequest	Run request defining what dataset to run against. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: RunCheckResponse

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ RunCheckDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RunCheckResponse> Lusid.Sdk.Api.ICheckDefinitionsApiSync.RunCheckDefinitionWithHttpInfo	(	string	scope,
		string	code,
		RunCheckRequest?	runCheckRequest = `default(RunCheckRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.

Runs a Check Definition against given dataset.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the CheckDefinition to run.
code	Code of the CheckDefinition to run.
runCheckRequest	Run request defining what dataset to run against. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of RunCheckResponse

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ UpdateCheckDefinition()

CheckDefinition Lusid.Sdk.Api.ICheckDefinitionsApiSync.UpdateCheckDefinition	(	string	scope,
		string	code,
		UpdateCheckDefinitionRequest?	updateCheckDefinitionRequest = `default(UpdateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code

Overwrites an existing Check Definition Update request has the same required fields as Create apart from the id. Returns the updated Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
updateCheckDefinitionRequest	The request containing the updated details of the Check Definition (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ UpdateCheckDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CheckDefinition> Lusid.Sdk.Api.ICheckDefinitionsApiSync.UpdateCheckDefinitionWithHttpInfo	(	string	scope,
		string	code,
		UpdateCheckDefinitionRequest?	updateCheckDefinitionRequest = `default(UpdateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code

Overwrites an existing Check Definition Update request has the same required fields as Create apart from the id. Returns the updated Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
updateCheckDefinitionRequest	The request containing the updated details of the Check Definition (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ UpsertRules()

CheckDefinition Lusid.Sdk.Api.ICheckDefinitionsApiSync.UpsertRules	(	string	scope,
		string	code,
		List< UpsertDataQualityRule >?	upsertDataQualityRule = `default(List< UpsertDataQualityRule >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition

Upsert rules for a given check definition. This will not affect any other rules that are not included in the request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
upsertDataQualityRule	The request containing the rules to be upserted (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

◆ UpsertRulesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CheckDefinition> Lusid.Sdk.Api.ICheckDefinitionsApiSync.UpsertRulesWithHttpInfo	(	string	scope,
		string	code,
		List< UpsertDataQualityRule >?	upsertDataQualityRule = `default(List< UpsertDataQualityRule >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition

Upsert rules for a given check definition. This will not affect any other rules that are not included in the request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified Check Definition.
code	The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.
upsertDataQualityRule	The request containing the rules to be upserted (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CheckDefinition

Implemented in Lusid.Sdk.Api.CheckDefinitionsApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/CheckDefinitionsApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateCheckDefinition()

◆ CreateCheckDefinitionWithHttpInfo()

◆ DeleteCheckDefinition()

◆ DeleteCheckDefinitionWithHttpInfo()

◆ DeleteRules()

◆ DeleteRulesWithHttpInfo()

◆ GetCheckDefinition()

◆ GetCheckDefinitionWithHttpInfo()

◆ ListCheckDefinitions()

◆ ListCheckDefinitionsWithHttpInfo()

◆ RunCheckDefinition()

◆ RunCheckDefinitionWithHttpInfo()

◆ UpdateCheckDefinition()

◆ UpdateCheckDefinitionWithHttpInfo()

◆ UpsertRules()

◆ UpsertRulesWithHttpInfo()