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

Inheritance diagram for Lusid.Sdk.Api.ICustomDataModelsApiSync:

[legend]

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

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

CustomDataModel	CreateCustomDataModel (string entityType, CreateCustomDataModelRequest? createCustomDataModelRequest=default(CreateCustomDataModelRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model More...

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

DeletedEntityResponse	DeleteCustomDataModel (string entityType, string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteCustomDataModelWithHttpInfo (string entityType, string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model More...

CustomDataModel	GetCustomDataModel (string entityType, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model More...

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

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

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

ResourceListOfString	ListSupportedEntityTypes (int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. More...

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

CustomDataModel	UpdateCustomDataModel (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model More...

Lusid.Sdk.Client.ApiResponse< CustomDataModel >	UpdateCustomDataModelWithHttpInfo (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, 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

◆ BatchAmend()

BatchAmendCustomDataModelMembershipResponse Lusid.Sdk.Api.ICustomDataModelsApiSync.BatchAmend	(	string	successMode,
		Dictionary< string, MembershipAmendmentRequest >	requestBody,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: BatchAmendCustomDataModelMembershipResponse

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ BatchAmendWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BatchAmendCustomDataModelMembershipResponse> Lusid.Sdk.Api.ICustomDataModelsApiSync.BatchAmendWithHttpInfo	(	string	successMode,
		Dictionary< string, MembershipAmendmentRequest >	requestBody,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of BatchAmendCustomDataModelMembershipResponse

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ CreateCustomDataModel()

CustomDataModel Lusid.Sdk.Api.ICustomDataModelsApiSync.CreateCustomDataModel	(	string	entityType,
		CreateCustomDataModelRequest?	createCustomDataModelRequest = `default(CreateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ CreateCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomDataModel> Lusid.Sdk.Api.ICustomDataModelsApiSync.CreateCustomDataModelWithHttpInfo	(	string	entityType,
		CreateCustomDataModelRequest?	createCustomDataModelRequest = `default(CreateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ DeleteCustomDataModel()

DeletedEntityResponse Lusid.Sdk.Api.ICustomDataModelsApiSync.DeleteCustomDataModel	(	string	entityType,
		string	scope,
		string	code,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ DeleteCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ICustomDataModelsApiSync.DeleteCustomDataModelWithHttpInfo	(	string	entityType,
		string	scope,
		string	code,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ GetCustomDataModel()

CustomDataModel Lusid.Sdk.Api.ICustomDataModelsApiSync.GetCustomDataModel	(	string	entityType,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ GetCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomDataModel> Lusid.Sdk.Api.ICustomDataModelsApiSync.GetCustomDataModelWithHttpInfo	(	string	entityType,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListDataModelHierarchies()

ResourceListOfDataModelSummary Lusid.Sdk.Api.ICustomDataModelsApiSync.ListDataModelHierarchies	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ResourceListOfDataModelSummary

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListDataModelHierarchiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfDataModelSummary> Lusid.Sdk.Api.ICustomDataModelsApiSync.ListDataModelHierarchiesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfDataModelSummary

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListSupportedEntityTypes()

ResourceListOfString Lusid.Sdk.Api.ICustomDataModelsApiSync.ListSupportedEntityTypes	(	int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ResourceListOfString

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ ListSupportedEntityTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfString> Lusid.Sdk.Api.ICustomDataModelsApiSync.ListSupportedEntityTypesWithHttpInfo	(	int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfString

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ UpdateCustomDataModel()

CustomDataModel Lusid.Sdk.Api.ICustomDataModelsApiSync.UpdateCustomDataModel	(	string	entityType,
		string	scope,
		string	code,
		UpdateCustomDataModelRequest?	updateCustomDataModelRequest = `default(UpdateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: CustomDataModel

Implemented in Lusid.Sdk.Api.CustomDataModelsApi.

◆ UpdateCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomDataModel> Lusid.Sdk.Api.ICustomDataModelsApiSync.UpdateCustomDataModelWithHttpInfo	(	string	entityType,
		string	scope,
		string	code,
		UpdateCustomDataModelRequest?	updateCustomDataModelRequest = `default(UpdateCustomDataModelRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of 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

◆ BatchAmend()

◆ BatchAmendWithHttpInfo()

◆ CreateCustomDataModel()

◆ CreateCustomDataModelWithHttpInfo()

◆ DeleteCustomDataModel()

◆ DeleteCustomDataModelWithHttpInfo()

◆ GetCustomDataModel()

◆ GetCustomDataModelWithHttpInfo()

◆ ListDataModelHierarchies()

◆ ListDataModelHierarchiesWithHttpInfo()

◆ ListSupportedEntityTypes()

◆ ListSupportedEntityTypesWithHttpInfo()

◆ UpdateCustomDataModel()

◆ UpdateCustomDataModelWithHttpInfo()