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

Inheritance diagram for Lusid.Sdk.Api.ICustomDataModelsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< BatchAmendCustomDataModelMembershipResponse >	BatchAmendAsync (string successMode, Dictionary< string, MembershipAmendmentRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< BatchAmendCustomDataModelMembershipResponse > >	BatchAmendWithHttpInfoAsync (string successMode, Dictionary< string, MembershipAmendmentRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. More...

System.Threading.Tasks.Task< CustomDataModel >	CreateCustomDataModelAsync (string entityType, CreateCustomDataModelRequest? createCustomDataModelRequest=default(CreateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomDataModel > >	CreateCustomDataModelWithHttpInfoAsync (string entityType, CreateCustomDataModelRequest? createCustomDataModelRequest=default(CreateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteCustomDataModelAsync (string entityType, string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteCustomDataModelWithHttpInfoAsync (string entityType, string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model More...

System.Threading.Tasks.Task< CustomDataModel >	GetCustomDataModelAsync (string entityType, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomDataModel > >	GetCustomDataModelWithHttpInfoAsync (string entityType, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model More...

System.Threading.Tasks.Task< ResourceListOfDataModelSummary >	ListDataModelHierarchiesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfDataModelSummary > >	ListDataModelHierarchiesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. More...

System.Threading.Tasks.Task< ResourceListOfString >	ListSupportedEntityTypesAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfString > >	ListSupportedEntityTypesWithHttpInfoAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. More...

System.Threading.Tasks.Task< CustomDataModel >	UpdateCustomDataModelAsync (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomDataModel > >	UpdateCustomDataModelWithHttpInfoAsync (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ BatchAmendAsync()

System.Threading.Tasks.Task<BatchAmendCustomDataModelMembershipResponse> Lusid.Sdk.Api.ICustomDataModelsApiAsync.BatchAmendAsync	(	string	successMode,
		Dictionary< string, MembershipAmendmentRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership.

Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.

Exceptions

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

Parameters

successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBody	The payload describing the amendments to make for the given Custom Data Model.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of BatchAmendCustomDataModelMembershipResponse

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ BatchAmendWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BatchAmendCustomDataModelMembershipResponse> > Lusid.Sdk.Api.ICustomDataModelsApiAsync.BatchAmendWithHttpInfoAsync	(	string	successMode,
		Dictionary< string, MembershipAmendmentRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership.

Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.

Exceptions

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

Parameters

successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBody	The payload describing the amendments to make for the given Custom Data Model.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (BatchAmendCustomDataModelMembershipResponse)

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ CreateCustomDataModelAsync()

System.Threading.Tasks.Task<CustomDataModel> Lusid.Sdk.Api.ICustomDataModelsApiAsync.CreateCustomDataModelAsync	(	string	entityType,
		CreateCustomDataModelRequest?	createCustomDataModelRequest = `default(CreateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model

Creates a Custom Data Model.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
createCustomDataModelRequest	The request containing the details of the Data Model. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ CreateCustomDataModelWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomDataModel> > Lusid.Sdk.Api.ICustomDataModelsApiAsync.CreateCustomDataModelWithHttpInfoAsync	(	string	entityType,
		CreateCustomDataModelRequest?	createCustomDataModelRequest = `default(CreateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model

Creates a Custom Data Model.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
createCustomDataModelRequest	The request containing the details of the Data Model. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CustomDataModel)

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ DeleteCustomDataModelAsync()

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

[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model

Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
scope	The scope of the specified Data Model.
code	The code of the specified Data Model.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ DeleteCustomDataModelWithHttpInfoAsync()

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

[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model

Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
scope	The scope of the specified Data Model.
code	The code of the specified Data Model.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ GetCustomDataModelAsync()

System.Threading.Tasks.Task<CustomDataModel> Lusid.Sdk.Api.ICustomDataModelsApiAsync.GetCustomDataModelAsync	(	string	entityType,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model

Retrieves a Custom Data Model at a given as at time.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
scope	The scope of the specified Data Model.
code	The code of the specified Data Model.
asAt	The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ GetCustomDataModelWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomDataModel> > Lusid.Sdk.Api.ICustomDataModelsApiAsync.GetCustomDataModelWithHttpInfoAsync	(	string	entityType,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model

Retrieves a Custom Data Model at a given as at time.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
scope	The scope of the specified Data Model.
code	The code of the specified Data Model.
asAt	The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CustomDataModel)

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListDataModelHierarchiesAsync()

System.Threading.Tasks.Task<ResourceListOfDataModelSummary> Lusid.Sdk.Api.ICustomDataModelsApiAsync.ListDataModelHierarchiesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies.

Lists the data model summaries within their hierarchical structure.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
filter	Expression to filter the results. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfDataModelSummary

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListDataModelHierarchiesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfDataModelSummary> > Lusid.Sdk.Api.ICustomDataModelsApiAsync.ListDataModelHierarchiesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies.

Lists the data model summaries within their hierarchical structure.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
filter	Expression to filter the results. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfDataModelSummary)

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListSupportedEntityTypesAsync()

System.Threading.Tasks.Task<ResourceListOfString> Lusid.Sdk.Api.ICustomDataModelsApiAsync.ListSupportedEntityTypesAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models.

Lists the currently supported entity types available to bind with Custom Data Models.

Exceptions

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

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfString

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListSupportedEntityTypesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfString> > Lusid.Sdk.Api.ICustomDataModelsApiAsync.ListSupportedEntityTypesWithHttpInfoAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models.

Lists the currently supported entity types available to bind with Custom Data Models.

Exceptions

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

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfString)

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ UpdateCustomDataModelAsync()

System.Threading.Tasks.Task<CustomDataModel> Lusid.Sdk.Api.ICustomDataModelsApiAsync.UpdateCustomDataModelAsync	(	string	entityType,
		string	scope,
		string	code,
		UpdateCustomDataModelRequest?	updateCustomDataModelRequest = `default(UpdateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model

Updates a Custom Data Model.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
scope	The scope of the specified Data Model.
code	The code of the specified Data Model.
updateCustomDataModelRequest	The request containing the details of the Data Model. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ UpdateCustomDataModelWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomDataModel> > Lusid.Sdk.Api.ICustomDataModelsApiAsync.UpdateCustomDataModelWithHttpInfoAsync	(	string	entityType,
		string	scope,
		string	code,
		UpdateCustomDataModelRequest?	updateCustomDataModelRequest = `default(UpdateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model

Updates a Custom Data Model.

Exceptions

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

Parameters

entityType	The entity type of the Data Model.
scope	The scope of the specified Data Model.
code	The code of the specified Data Model.
updateCustomDataModelRequest	The request containing the details of the Data Model. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CustomDataModel)

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ BatchAmendAsync()

◆ BatchAmendWithHttpInfoAsync()

◆ CreateCustomDataModelAsync()

◆ CreateCustomDataModelWithHttpInfoAsync()

◆ DeleteCustomDataModelAsync()

◆ DeleteCustomDataModelWithHttpInfoAsync()

◆ GetCustomDataModelAsync()

◆ GetCustomDataModelWithHttpInfoAsync()

◆ ListDataModelHierarchiesAsync()

◆ ListDataModelHierarchiesWithHttpInfoAsync()

◆ ListSupportedEntityTypesAsync()

◆ ListSupportedEntityTypesWithHttpInfoAsync()

◆ UpdateCustomDataModelAsync()

◆ UpdateCustomDataModelWithHttpInfoAsync()