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

Inheritance diagram for Lusid.Sdk.Api.CheckDefinitionsApi:

[legend]

Public Member Functions
	CheckDefinitionsApi ()
	Initializes a new instance of the CheckDefinitionsApi class. More...

	CheckDefinitionsApi (string basePath)
	Initializes a new instance of the CheckDefinitionsApi class. More...

	CheckDefinitionsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the CheckDefinitionsApi class using Configuration object More...

	CheckDefinitionsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the CheckDefinitionsApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

CheckDefinition	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 More...

Lusid.Sdk.Client.ApiResponse< CheckDefinition >	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 More...

async System.Threading.Tasks.Task< CheckDefinition >	CreateCheckDefinitionAsync (CreateCheckDefinitionRequest? createCheckDefinitionRequest=default(CreateCheckDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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 More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CheckDefinition > >	CreateCheckDefinitionWithHttpInfoAsync (CreateCheckDefinitionRequest? createCheckDefinitionRequest=default(CreateCheckDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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 More...

DeletedEntityResponse	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. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	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. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteCheckDefinitionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteCheckDefinitionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. 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 Delete rules for a given check definition. This will not affect any other rules that are not included in the request. 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 Delete rules for a given check definition. This will not affect any other rules that are not included in the request. More...

async System.Threading.Tasks.Task< CheckDefinition >	DeleteRulesAsync (string scope, string code, List< DeleteDataQualityRule >? deleteDataQualityRule=default(List< DeleteDataQualityRule >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CheckDefinition > >	DeleteRulesWithHttpInfoAsync (string scope, string code, List< DeleteDataQualityRule >? deleteDataQualityRule=default(List< DeleteDataQualityRule >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. 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. Retrieves one Check Definition by scope and code. Check Definitions are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. 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. Retrieves one Check Definition by scope and code. Check Definitions are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. More...

async System.Threading.Tasks.Task< CheckDefinition >	GetCheckDefinitionAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CheckDefinition > >	GetCheckDefinitionWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. 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 List all the Check Definitions matching a particular criteria. 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 List all the Check Definitions matching a particular criteria. More...

async System.Threading.Tasks.Task< PagedResourceListOfCheckDefinition >	ListCheckDefinitionsAsync (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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions List all the Check Definitions matching a particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCheckDefinition > >	ListCheckDefinitionsWithHttpInfoAsync (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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions List all the Check Definitions matching a particular criteria. 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. 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. Runs a Check Definition against given dataset. More...

async System.Threading.Tasks.Task< RunCheckResponse >	RunCheckDefinitionAsync (string scope, string code, RunCheckRequest? runCheckRequest=default(RunCheckRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset. Runs a Check Definition against given dataset. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RunCheckResponse > >	RunCheckDefinitionWithHttpInfoAsync (string scope, string code, RunCheckRequest? runCheckRequest=default(RunCheckRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset. 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 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 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 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 More...

async System.Threading.Tasks.Task< CheckDefinition >	UpdateCheckDefinitionAsync (string scope, string code, UpdateCheckDefinitionRequest? updateCheckDefinitionRequest=default(UpdateCheckDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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 More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CheckDefinition > >	UpdateCheckDefinitionWithHttpInfoAsync (string scope, string code, UpdateCheckDefinitionRequest? updateCheckDefinitionRequest=default(UpdateCheckDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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 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 Upsert rules for a given check definition. This will not affect any other rules that are not included in the request. 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 Upsert rules for a given check definition. This will not affect any other rules that are not included in the request. More...

async System.Threading.Tasks.Task< CheckDefinition >	UpsertRulesAsync (string scope, string code, List< UpsertDataQualityRule >? upsertDataQualityRule=default(List< UpsertDataQualityRule >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CheckDefinition > >	UpsertRulesWithHttpInfoAsync (string scope, string code, List< UpsertDataQualityRule >? upsertDataQualityRule=default(List< UpsertDataQualityRule >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), 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. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ CheckDefinitionsApi() [1/4]

Lusid.Sdk.Api.CheckDefinitionsApi.CheckDefinitionsApi ( )

inline

Initializes a new instance of the CheckDefinitionsApi class.

Returns

◆ CheckDefinitionsApi() [2/4]

Lusid.Sdk.Api.CheckDefinitionsApi.CheckDefinitionsApi ( string basePath )

inline

Initializes a new instance of the CheckDefinitionsApi class.

Returns

◆ CheckDefinitionsApi() [3/4]

Lusid.Sdk.Api.CheckDefinitionsApi.CheckDefinitionsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the CheckDefinitionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ CheckDefinitionsApi() [4/4]

Lusid.Sdk.Api.CheckDefinitionsApi.CheckDefinitionsApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the CheckDefinitionsApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ CreateCheckDefinition()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ CreateCheckDefinitionAsync()

async System.Threading.Tasks.Task<CheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.CreateCheckDefinitionAsync	(	CreateCheckDefinitionRequest?	createCheckDefinitionRequest = `default(CreateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CheckDefinition

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ CreateCheckDefinitionWithHttpInfo()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ CreateCheckDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CheckDefinition> > Lusid.Sdk.Api.CheckDefinitionsApi.CreateCheckDefinitionWithHttpInfoAsync	(	CreateCheckDefinitionRequest?	createCheckDefinitionRequest = `default(CreateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CheckDefinition)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ DeleteCheckDefinition()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ DeleteCheckDefinitionAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.CheckDefinitionsApi.DeleteCheckDefinitionAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ DeleteCheckDefinitionWithHttpInfo()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ DeleteCheckDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.CheckDefinitionsApi.DeleteCheckDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ DeleteRules()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ DeleteRulesAsync()

async System.Threading.Tasks.Task<CheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.DeleteRulesAsync	(	string	scope,
		string	code,
		List< DeleteDataQualityRule >?	deleteDataQualityRule = `default(List<DeleteDataQualityRule>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CheckDefinition

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ DeleteRulesWithHttpInfo()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ DeleteRulesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CheckDefinition> > Lusid.Sdk.Api.CheckDefinitionsApi.DeleteRulesWithHttpInfoAsync	(	string	scope,
		string	code,
		List< DeleteDataQualityRule >?	deleteDataQualityRule = `default(List<DeleteDataQualityRule>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CheckDefinition)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.CheckDefinitionsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ GetCheckDefinition()

CheckDefinition Lusid.Sdk.Api.CheckDefinitionsApi.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`
	)

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ GetCheckDefinitionAsync()

async System.Threading.Tasks.Task<CheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.GetCheckDefinitionAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CheckDefinition

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ GetCheckDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.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`
	)

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ GetCheckDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CheckDefinition> > Lusid.Sdk.Api.CheckDefinitionsApi.GetCheckDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CheckDefinition)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ ListCheckDefinitions()

PagedResourceListOfCheckDefinition Lusid.Sdk.Api.CheckDefinitionsApi.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`
	)

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ ListCheckDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfCheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.ListCheckDefinitionsAsync	(	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`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfCheckDefinition

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ ListCheckDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.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`
	)

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ ListCheckDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCheckDefinition> > Lusid.Sdk.Api.CheckDefinitionsApi.ListCheckDefinitionsWithHttpInfoAsync	(	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`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfCheckDefinition)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ RunCheckDefinition()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ RunCheckDefinitionAsync()

async System.Threading.Tasks.Task<RunCheckResponse> Lusid.Sdk.Api.CheckDefinitionsApi.RunCheckDefinitionAsync	(	string	scope,
		string	code,
		RunCheckRequest?	runCheckRequest = `default(RunCheckRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of RunCheckResponse

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ RunCheckDefinitionWithHttpInfo()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ RunCheckDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RunCheckResponse> > Lusid.Sdk.Api.CheckDefinitionsApi.RunCheckDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		RunCheckRequest?	runCheckRequest = `default(RunCheckRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (RunCheckResponse)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ UpdateCheckDefinition()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ UpdateCheckDefinitionAsync()

async System.Threading.Tasks.Task<CheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.UpdateCheckDefinitionAsync	(	string	scope,
		string	code,
		UpdateCheckDefinitionRequest?	updateCheckDefinitionRequest = `default(UpdateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CheckDefinition

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ UpdateCheckDefinitionWithHttpInfo()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ UpdateCheckDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CheckDefinition> > Lusid.Sdk.Api.CheckDefinitionsApi.UpdateCheckDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateCheckDefinitionRequest?	updateCheckDefinitionRequest = `default(UpdateCheckDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CheckDefinition)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ UpsertRules()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ UpsertRulesAsync()

async System.Threading.Tasks.Task<CheckDefinition> Lusid.Sdk.Api.CheckDefinitionsApi.UpsertRulesAsync	(	string	scope,
		string	code,
		List< UpsertDataQualityRule >?	upsertDataQualityRule = `default(List<UpsertDataQualityRule>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CheckDefinition

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

◆ UpsertRulesWithHttpInfo()

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

inline

[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

Implements Lusid.Sdk.Api.ICheckDefinitionsApiSync.

◆ UpsertRulesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CheckDefinition> > Lusid.Sdk.Api.CheckDefinitionsApi.UpsertRulesWithHttpInfoAsync	(	string	scope,
		string	code,
		List< UpsertDataQualityRule >?	upsertDataQualityRule = `default(List<UpsertDataQualityRule>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CheckDefinition)

Implements Lusid.Sdk.Api.ICheckDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.CheckDefinitionsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.CheckDefinitionsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.CheckDefinitionsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.CheckDefinitionsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class 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

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CheckDefinitionsApi() [1/4]

◆ CheckDefinitionsApi() [2/4]

◆ CheckDefinitionsApi() [3/4]

◆ CheckDefinitionsApi() [4/4]

Member Function Documentation

◆ CreateCheckDefinition()

◆ CreateCheckDefinitionAsync()

◆ CreateCheckDefinitionWithHttpInfo()

◆ CreateCheckDefinitionWithHttpInfoAsync()

◆ DeleteCheckDefinition()

◆ DeleteCheckDefinitionAsync()

◆ DeleteCheckDefinitionWithHttpInfo()

◆ DeleteCheckDefinitionWithHttpInfoAsync()

◆ DeleteRules()

◆ DeleteRulesAsync()

◆ DeleteRulesWithHttpInfo()

◆ DeleteRulesWithHttpInfoAsync()

◆ GetBasePath()

◆ GetCheckDefinition()

◆ GetCheckDefinitionAsync()

◆ GetCheckDefinitionWithHttpInfo()

◆ GetCheckDefinitionWithHttpInfoAsync()

◆ ListCheckDefinitions()

◆ ListCheckDefinitionsAsync()

◆ ListCheckDefinitionsWithHttpInfo()

◆ ListCheckDefinitionsWithHttpInfoAsync()

◆ RunCheckDefinition()

◆ RunCheckDefinitionAsync()

◆ RunCheckDefinitionWithHttpInfo()

◆ RunCheckDefinitionWithHttpInfoAsync()

◆ UpdateCheckDefinition()

◆ UpdateCheckDefinitionAsync()

◆ UpdateCheckDefinitionWithHttpInfo()

◆ UpdateCheckDefinitionWithHttpInfoAsync()

◆ UpsertRules()

◆ UpsertRulesAsync()

◆ UpsertRulesWithHttpInfo()

◆ UpsertRulesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory