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

Inheritance diagram for Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< CustomEntityDefinition >	CreateCustomEntityDefinitionAsync (CustomEntityDefinitionRequest customEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. More...

System.Threading.Tasks.Task< ApiResponse< CustomEntityDefinition > >	CreateCustomEntityDefinitionWithHttpInfoAsync (CustomEntityDefinitionRequest customEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. More...

System.Threading.Tasks.Task< CustomEntityDefinition >	GetDefinitionAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. More...

System.Threading.Tasks.Task< ApiResponse< CustomEntityDefinition > >	GetDefinitionWithHttpInfoAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. More...

System.Threading.Tasks.Task< PagedResourceListOfCustomEntityDefinition >	ListCustomEntityDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfCustomEntityDefinition > >	ListCustomEntityDefinitionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions More...

System.Threading.Tasks.Task< CustomEntityDefinition >	UpdateCustomEntityDefinitionAsync (string entityType, UpdateCustomEntityDefinitionRequest updateCustomEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. More...

System.Threading.Tasks.Task< ApiResponse< CustomEntityDefinition > >	UpdateCustomEntityDefinitionWithHttpInfoAsync (string entityType, UpdateCustomEntityDefinitionRequest updateCustomEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. 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

◆ CreateCustomEntityDefinitionAsync()

System.Threading.Tasks.Task<CustomEntityDefinition> Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.CreateCustomEntityDefinitionAsync	(	CustomEntityDefinitionRequest	customEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type.

The API will return a Bad Request if the Custom Entity type already exists.

Exceptions

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

Parameters

customEntityDefinitionRequest	The payload containing the description of the Custom Entity type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CustomEntityDefinition

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

◆ CreateCustomEntityDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustomEntityDefinition> > Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.CreateCustomEntityDefinitionWithHttpInfoAsync	(	CustomEntityDefinitionRequest	customEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type.

The API will return a Bad Request if the Custom Entity type already exists.

Exceptions

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

Parameters

customEntityDefinitionRequest	The payload containing the description of the Custom Entity type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CustomEntityDefinition)

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

◆ GetDefinitionAsync()

System.Threading.Tasks.Task<CustomEntityDefinition> Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.GetDefinitionAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition.

Retrieve a CustomEntityDefinition by a specific entityType at a point in AsAt time

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity type, derived from the "entityTypeName" provided on creation.
asAt	The AsAt datetime at which to retrieve the definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CustomEntityDefinition

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

◆ GetDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustomEntityDefinition> > Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.GetDefinitionWithHttpInfoAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition.

Retrieve a CustomEntityDefinition by a specific entityType at a point in AsAt time

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity type, derived from the "entityTypeName" provided on creation.
asAt	The AsAt datetime at which to retrieve the definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CustomEntityDefinition)

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

◆ ListCustomEntityDefinitionsAsync()

System.Threading.Tasks.Task<PagedResourceListOfCustomEntityDefinition> Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.ListCustomEntityDefinitionsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions

List all Custom Entity type definitions matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfCustomEntityDefinition

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

◆ ListCustomEntityDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfCustomEntityDefinition> > Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.ListCustomEntityDefinitionsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions

List all Custom Entity type definitions matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfCustomEntityDefinition)

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

◆ UpdateCustomEntityDefinitionAsync()

System.Threading.Tasks.Task<CustomEntityDefinition> Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.UpdateCustomEntityDefinitionAsync	(	string	entityType,
		UpdateCustomEntityDefinitionRequest	updateCustomEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type.

The API will return a Bad Request if the Custom Entity type does not exist.

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity type, derived from the "entityTypeName" provided on creation.
updateCustomEntityDefinitionRequest	The payload containing the description of the Custom Entity type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CustomEntityDefinition

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

◆ UpdateCustomEntityDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustomEntityDefinition> > Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.UpdateCustomEntityDefinitionWithHttpInfoAsync	(	string	entityType,
		UpdateCustomEntityDefinitionRequest	updateCustomEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type.

The API will return a Bad Request if the Custom Entity type does not exist.

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity type, derived from the "entityTypeName" provided on creation.
updateCustomEntityDefinitionRequest	The payload containing the description of the Custom Entity type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CustomEntityDefinition)

Implemented in Lusid.Sdk.Api.CustomEntityDefinitionsApi.

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/CustomEntityDefinitionsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateCustomEntityDefinitionAsync()

◆ CreateCustomEntityDefinitionWithHttpInfoAsync()

◆ GetDefinitionAsync()

◆ GetDefinitionWithHttpInfoAsync()

◆ ListCustomEntityDefinitionsAsync()

◆ ListCustomEntityDefinitionsWithHttpInfoAsync()

◆ UpdateCustomEntityDefinitionAsync()

◆ UpdateCustomEntityDefinitionWithHttpInfoAsync()