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

Inheritance diagram for Lusid.Sdk.Api.CustomEntityDefinitionsApi:

[legend]

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

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

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

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

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

CustomEntityDefinition	CreateCustomEntityDefinition (CustomEntityDefinitionRequest customEntityDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. The API will return a Bad Request if the Custom Entity type already exists. More...

Lusid.Sdk.Client.ApiResponse< CustomEntityDefinition >	CreateCustomEntityDefinitionWithHttpInfo (CustomEntityDefinitionRequest customEntityDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. The API will return a Bad Request if the Custom Entity type already exists. More...

async System.Threading.Tasks.Task< CustomEntityDefinition >	CreateCustomEntityDefinitionAsync (CustomEntityDefinitionRequest customEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. The API will return a Bad Request if the Custom Entity type already exists. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomEntityDefinition > >	CreateCustomEntityDefinitionWithHttpInfoAsync (CustomEntityDefinitionRequest customEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. The API will return a Bad Request if the Custom Entity type already exists. More...

CustomEntityDefinition	GetDefinition (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. Retrieve a CustomEntityDefinition by a specific entityType at a point in AsAt time More...

Lusid.Sdk.Client.ApiResponse< CustomEntityDefinition >	GetDefinitionWithHttpInfo (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. Retrieve a CustomEntityDefinition by a specific entityType at a point in AsAt time More...

async System.Threading.Tasks.Task< CustomEntityDefinition >	GetDefinitionAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. Retrieve a CustomEntityDefinition by a specific entityType at a point in AsAt time More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomEntityDefinition > >	GetDefinitionWithHttpInfoAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. Retrieve a CustomEntityDefinition by a specific entityType at a point in AsAt time More...

PagedResourceListOfCustomEntityDefinition	ListCustomEntityDefinitions (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions List all Custom Entity type definitions matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCustomEntityDefinition >	ListCustomEntityDefinitionsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions List all Custom Entity type definitions matching particular criteria. More...

async 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), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions List all Custom Entity type definitions matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions List all Custom Entity type definitions matching particular criteria. More...

CustomEntityDefinition	UpdateCustomEntityDefinition (string entityType, UpdateCustomEntityDefinitionRequest updateCustomEntityDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. The API will return a Bad Request if the Custom Entity type does not exist. More...

Lusid.Sdk.Client.ApiResponse< CustomEntityDefinition >	UpdateCustomEntityDefinitionWithHttpInfo (string entityType, UpdateCustomEntityDefinitionRequest updateCustomEntityDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. The API will return a Bad Request if the Custom Entity type does not exist. More...

async System.Threading.Tasks.Task< CustomEntityDefinition >	UpdateCustomEntityDefinitionAsync (string entityType, UpdateCustomEntityDefinitionRequest updateCustomEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. The API will return a Bad Request if the Custom Entity type does not exist. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomEntityDefinition > >	UpdateCustomEntityDefinitionWithHttpInfoAsync (string entityType, UpdateCustomEntityDefinitionRequest updateCustomEntityDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. The API will return a Bad Request if the Custom Entity type does not exist. 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

◆ CustomEntityDefinitionsApi() [1/4]

Lusid.Sdk.Api.CustomEntityDefinitionsApi.CustomEntityDefinitionsApi ( )

inline

Initializes a new instance of the CustomEntityDefinitionsApi class.

Returns

◆ CustomEntityDefinitionsApi() [2/4]

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

inline

Initializes a new instance of the CustomEntityDefinitionsApi class.

Returns

◆ CustomEntityDefinitionsApi() [3/4]

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

inline

Initializes a new instance of the CustomEntityDefinitionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ CustomEntityDefinitionsApi() [4/4]

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

inline

Initializes a new instance of the CustomEntityDefinitionsApi 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

◆ CreateCustomEntityDefinition()

CustomEntityDefinition Lusid.Sdk.Api.CustomEntityDefinitionsApi.CreateCustomEntityDefinition	(	CustomEntityDefinitionRequest	customEntityDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ CreateCustomEntityDefinitionAsync()

async System.Threading.Tasks.Task<CustomEntityDefinition> Lusid.Sdk.Api.CustomEntityDefinitionsApi.CreateCustomEntityDefinitionAsync	(	CustomEntityDefinitionRequest	customEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

◆ CreateCustomEntityDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomEntityDefinition> Lusid.Sdk.Api.CustomEntityDefinitionsApi.CreateCustomEntityDefinitionWithHttpInfo	(	CustomEntityDefinitionRequest	customEntityDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ CreateCustomEntityDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityDefinition> > Lusid.Sdk.Api.CustomEntityDefinitionsApi.CreateCustomEntityDefinitionWithHttpInfoAsync	(	CustomEntityDefinitionRequest	customEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (CustomEntityDefinition)

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ GetDefinition()

CustomEntityDefinition Lusid.Sdk.Api.CustomEntityDefinitionsApi.GetDefinition	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ GetDefinitionAsync()

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

inline

[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.
opts	Options for this request.

Returns: Task of CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

◆ GetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomEntityDefinition> Lusid.Sdk.Api.CustomEntityDefinitionsApi.GetDefinitionWithHttpInfo	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ GetDefinitionWithHttpInfoAsync()

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

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (CustomEntityDefinition)

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

◆ ListCustomEntityDefinitions()

PagedResourceListOfCustomEntityDefinition Lusid.Sdk.Api.CustomEntityDefinitionsApi.ListCustomEntityDefinitions	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: PagedResourceListOfCustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ ListCustomEntityDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfCustomEntityDefinition> Lusid.Sdk.Api.CustomEntityDefinitionsApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of PagedResourceListOfCustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

◆ ListCustomEntityDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCustomEntityDefinition> Lusid.Sdk.Api.CustomEntityDefinitionsApi.ListCustomEntityDefinitionsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfCustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ ListCustomEntityDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCustomEntityDefinition> > Lusid.Sdk.Api.CustomEntityDefinitionsApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfCustomEntityDefinition)

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

◆ UpdateCustomEntityDefinition()

CustomEntityDefinition Lusid.Sdk.Api.CustomEntityDefinitionsApi.UpdateCustomEntityDefinition	(	string	entityType,
		UpdateCustomEntityDefinitionRequest	updateCustomEntityDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ UpdateCustomEntityDefinitionAsync()

async System.Threading.Tasks.Task<CustomEntityDefinition> Lusid.Sdk.Api.CustomEntityDefinitionsApi.UpdateCustomEntityDefinitionAsync	(	string	entityType,
		UpdateCustomEntityDefinitionRequest	updateCustomEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

◆ UpdateCustomEntityDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomEntityDefinition> Lusid.Sdk.Api.CustomEntityDefinitionsApi.UpdateCustomEntityDefinitionWithHttpInfo	(	string	entityType,
		UpdateCustomEntityDefinitionRequest	updateCustomEntityDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of CustomEntityDefinition

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiSync.

◆ UpdateCustomEntityDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityDefinition> > Lusid.Sdk.Api.CustomEntityDefinitionsApi.UpdateCustomEntityDefinitionWithHttpInfoAsync	(	string	entityType,
		UpdateCustomEntityDefinitionRequest	updateCustomEntityDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (CustomEntityDefinition)

Implements Lusid.Sdk.Api.ICustomEntityDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.CustomEntityDefinitionsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.CustomEntityDefinitionsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.CustomEntityDefinitionsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.CustomEntityDefinitionsApi.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/CustomEntityDefinitionsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CustomEntityDefinitionsApi() [1/4]

◆ CustomEntityDefinitionsApi() [2/4]

◆ CustomEntityDefinitionsApi() [3/4]

◆ CustomEntityDefinitionsApi() [4/4]

Member Function Documentation

◆ CreateCustomEntityDefinition()

◆ CreateCustomEntityDefinitionAsync()

◆ CreateCustomEntityDefinitionWithHttpInfo()

◆ CreateCustomEntityDefinitionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetDefinition()

◆ GetDefinitionAsync()

◆ GetDefinitionWithHttpInfo()

◆ GetDefinitionWithHttpInfoAsync()

◆ ListCustomEntityDefinitions()

◆ ListCustomEntityDefinitionsAsync()

◆ ListCustomEntityDefinitionsWithHttpInfo()

◆ ListCustomEntityDefinitionsWithHttpInfoAsync()

◆ UpdateCustomEntityDefinition()

◆ UpdateCustomEntityDefinitionAsync()

◆ UpdateCustomEntityDefinitionWithHttpInfo()

◆ UpdateCustomEntityDefinitionWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory