LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.ILegacyComplianceApiSync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.ILegacyComplianceApiSync:
Inheritance graph
[legend]

Public Member Functions

DeletedEntityResponse DeleteLegacyComplianceRule (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. More...
 
ApiResponse< DeletedEntityResponseDeleteLegacyComplianceRuleWithHttpInfo (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. More...
 
ResourceListOfComplianceBreachedOrderInfo GetLegacyBreachedOrdersInfo (string runId, string? orderScope=default(string?), string? orderCode=default(string?), int? limit=default(int?), int operationIndex=0)
 [EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. More...
 
ApiResponse< ResourceListOfComplianceBreachedOrderInfoGetLegacyBreachedOrdersInfoWithHttpInfo (string runId, string? orderScope=default(string?), string? orderCode=default(string?), int? limit=default(int?), int operationIndex=0)
 [EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. More...
 
ComplianceRule GetLegacyComplianceRule (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. More...
 
ApiResponse< ComplianceRuleGetLegacyComplianceRuleWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. More...
 
ResourceListOfComplianceRuleResult GetLegacyComplianceRunResults (string runId, string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. More...
 
ApiResponse< ResourceListOfComplianceRuleResultGetLegacyComplianceRunResultsWithHttpInfo (string runId, string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. More...
 
ResourceListOfComplianceRule ListLegacyComplianceRules (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. More...
 
ApiResponse< ResourceListOfComplianceRuleListLegacyComplianceRulesWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. More...
 
ResourceListOfComplianceRunInfo ListLegacyComplianceRunInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. More...
 
ApiResponse< ResourceListOfComplianceRunInfoListLegacyComplianceRunInfoWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. More...
 
ComplianceRunInfo RunLegacyCompliance (bool isPreTrade, string recipeIdScope, string? recipeIdCode=default(string?), bool? byTaxlots=default(bool?), int operationIndex=0)
 [EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process More...
 
ApiResponse< ComplianceRunInfoRunLegacyComplianceWithHttpInfo (bool isPreTrade, string recipeIdScope, string? recipeIdCode=default(string?), bool? byTaxlots=default(bool?), int operationIndex=0)
 [EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process More...
 
ComplianceRuleUpsertResponse UpsertLegacyComplianceRules (Dictionary< string, ComplianceRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. More...
 
ApiResponse< ComplianceRuleUpsertResponseUpsertLegacyComplianceRulesWithHttpInfo (Dictionary< string, ComplianceRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
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

Member Function Documentation

◆ DeleteLegacyComplianceRule()

DeletedEntityResponse Lusid.Sdk.Api.ILegacyComplianceApiSync.DeleteLegacyComplianceRule ( string  scope,
string  code,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule.

Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule scope.
codeThe compliance rule code.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ DeleteLegacyComplianceRuleWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ILegacyComplianceApiSync.DeleteLegacyComplianceRuleWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule.

Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule scope.
codeThe compliance rule code.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ GetLegacyBreachedOrdersInfo()

ResourceListOfComplianceBreachedOrderInfo Lusid.Sdk.Api.ILegacyComplianceApiSync.GetLegacyBreachedOrdersInfo ( string  runId,
string?  orderScope = default(string?),
string?  orderCode = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it.

Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
runIdThe RunId that the results should be checked for
orderScopeOptional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
orderCodeOptional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfComplianceBreachedOrderInfo

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ GetLegacyBreachedOrdersInfoWithHttpInfo()

ApiResponse<ResourceListOfComplianceBreachedOrderInfo> Lusid.Sdk.Api.ILegacyComplianceApiSync.GetLegacyBreachedOrdersInfoWithHttpInfo ( string  runId,
string?  orderScope = default(string?),
string?  orderCode = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it.

Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
runIdThe RunId that the results should be checked for
orderScopeOptional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
orderCodeOptional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfComplianceBreachedOrderInfo

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ GetLegacyComplianceRule()

ComplianceRule Lusid.Sdk.Api.ILegacyComplianceApiSync.GetLegacyComplianceRule ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule.

Retrieves the compliance rule definition at the given effective and as at times.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule scope.
codeThe compliance rule code.
effectiveAtThe effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ComplianceRule

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ GetLegacyComplianceRuleWithHttpInfo()

ApiResponse<ComplianceRule> Lusid.Sdk.Api.ILegacyComplianceApiSync.GetLegacyComplianceRuleWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule.

Retrieves the compliance rule definition at the given effective and as at times.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule scope.
codeThe compliance rule code.
effectiveAtThe effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ComplianceRule

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ GetLegacyComplianceRunResults()

ResourceListOfComplianceRuleResult Lusid.Sdk.Api.ILegacyComplianceApiSync.GetLegacyComplianceRunResults ( string  runId,
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run.

Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
runIdThe unique identifier of the compliance run requested.
pageThe pagination token to use to continue listing compliance rule results from a previous call to list compliance rule result. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfComplianceRuleResult

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ GetLegacyComplianceRunResultsWithHttpInfo()

ApiResponse<ResourceListOfComplianceRuleResult> Lusid.Sdk.Api.ILegacyComplianceApiSync.GetLegacyComplianceRunResultsWithHttpInfo ( string  runId,
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run.

Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
runIdThe unique identifier of the compliance run requested.
pageThe pagination token to use to continue listing compliance rule results from a previous call to list compliance rule result. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfComplianceRuleResult

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ ListLegacyComplianceRules()

ResourceListOfComplianceRule Lusid.Sdk.Api.ILegacyComplianceApiSync.ListLegacyComplianceRules ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering.

For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing entities; 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfComplianceRule

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ ListLegacyComplianceRulesWithHttpInfo()

ApiResponse<ResourceListOfComplianceRule> Lusid.Sdk.Api.ILegacyComplianceApiSync.ListLegacyComplianceRulesWithHttpInfo ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering.

For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing entities; 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfComplianceRule

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ ListLegacyComplianceRunInfo()

ResourceListOfComplianceRunInfo Lusid.Sdk.Api.ILegacyComplianceApiSync.ListLegacyComplianceRunInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids.

Use this endpoint to fetch a list of all historical compliance runs.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The time at which to get results from. Default : latest (optional)
pageThe pagination token to use to continue listing compliance runs from a previous call to list compliance runs. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfComplianceRunInfo

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ ListLegacyComplianceRunInfoWithHttpInfo()

ApiResponse<ResourceListOfComplianceRunInfo> Lusid.Sdk.Api.ILegacyComplianceApiSync.ListLegacyComplianceRunInfoWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids.

Use this endpoint to fetch a list of all historical compliance runs.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The time at which to get results from. Default : latest (optional)
pageThe pagination token to use to continue listing compliance runs from a previous call to list compliance runs. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfComplianceRunInfo

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ RunLegacyCompliance()

ComplianceRunInfo Lusid.Sdk.Api.ILegacyComplianceApiSync.RunLegacyCompliance ( bool  isPreTrade,
string  recipeIdScope,
string?  recipeIdCode = default(string?),
bool?  byTaxlots = default(bool?),
int  operationIndex = 0 
)

[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process

Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
isPreTradeRequired: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScopeRequired: the scope of the recipe to be used
recipeIdCodeOptional: The code of the recipe to be used. If left blank, the default recipe will be used. (optional)
byTaxlotsOptional. (optional)
operationIndexIndex associated with the operation.
Returns
ComplianceRunInfo

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ RunLegacyComplianceWithHttpInfo()

ApiResponse<ComplianceRunInfo> Lusid.Sdk.Api.ILegacyComplianceApiSync.RunLegacyComplianceWithHttpInfo ( bool  isPreTrade,
string  recipeIdScope,
string?  recipeIdCode = default(string?),
bool?  byTaxlots = default(bool?),
int  operationIndex = 0 
)

[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process

Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
isPreTradeRequired: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScopeRequired: the scope of the recipe to be used
recipeIdCodeOptional: The code of the recipe to be used. If left blank, the default recipe will be used. (optional)
byTaxlotsOptional. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ComplianceRunInfo

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ UpsertLegacyComplianceRules()

ComplianceRuleUpsertResponse Lusid.Sdk.Api.ILegacyComplianceApiSync.UpsertLegacyComplianceRules ( Dictionary< string, ComplianceRuleUpsertRequest requestBody,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules.

To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyA dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted compliance rule to the code of a created compliance rule.
effectiveAtThe effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndexIndex associated with the operation.
Returns
ComplianceRuleUpsertResponse

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.

◆ UpsertLegacyComplianceRulesWithHttpInfo()

ApiResponse<ComplianceRuleUpsertResponse> Lusid.Sdk.Api.ILegacyComplianceApiSync.UpsertLegacyComplianceRulesWithHttpInfo ( Dictionary< string, ComplianceRuleUpsertRequest requestBody,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules.

To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyA dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted compliance rule to the code of a created compliance rule.
effectiveAtThe effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ComplianceRuleUpsertResponse

Implemented in Lusid.Sdk.Api.LegacyComplianceApi.


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