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

Inheritance diagram for Lusid.Sdk.Api.CustomEntityTypesApi:

[legend]

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

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

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

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

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

CustomEntityType	CreateCustomEntityType (CreateCustomEntityTypeRequest createCustomEntityTypeRequest, int operationIndex=0)
	[EARLY ACCESS] CreateCustomEntityType: 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< CustomEntityType >	CreateCustomEntityTypeWithHttpInfo (CreateCustomEntityTypeRequest createCustomEntityTypeRequest, int operationIndex=0)
	[EARLY ACCESS] CreateCustomEntityType: 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< CustomEntityType >	CreateCustomEntityTypeAsync (CreateCustomEntityTypeRequest createCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateCustomEntityType: 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< CustomEntityType > >	CreateCustomEntityTypeWithHttpInfoAsync (CreateCustomEntityTypeRequest createCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateCustomEntityType: Define a new Custom Entity Type. The API will return a Bad Request if the Custom Entity Type already exists. More...

CustomEntityType	GetCustomEntityType (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type at a point in AsAt time. More...

Lusid.Sdk.Client.ApiResponse< CustomEntityType >	GetCustomEntityTypeWithHttpInfo (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type at a point in AsAt time. More...

async System.Threading.Tasks.Task< CustomEntityType >	GetCustomEntityTypeAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type at a point in AsAt time. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomEntityType > >	GetCustomEntityTypeWithHttpInfoAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type at a point in AsAt time. More...

PagedResourceListOfCustomEntityType	ListCustomEntityTypes (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), int operationIndex=0)
	[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCustomEntityType >	ListCustomEntityTypesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), int operationIndex=0)
	[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types matching particular criteria. More...

async System.Threading.Tasks.Task< PagedResourceListOfCustomEntityType >	ListCustomEntityTypesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCustomEntityType > >	ListCustomEntityTypesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types matching particular criteria. More...

CustomEntityType	UpdateCustomEntityType (string entityType, UpdateCustomEntityTypeRequest updateCustomEntityTypeRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateCustomEntityType: 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< CustomEntityType >	UpdateCustomEntityTypeWithHttpInfo (string entityType, UpdateCustomEntityTypeRequest updateCustomEntityTypeRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateCustomEntityType: 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< CustomEntityType >	UpdateCustomEntityTypeAsync (string entityType, UpdateCustomEntityTypeRequest updateCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateCustomEntityType: 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< CustomEntityType > >	UpdateCustomEntityTypeWithHttpInfoAsync (string entityType, UpdateCustomEntityTypeRequest updateCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateCustomEntityType: 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...

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

Constructor & Destructor Documentation

◆ CustomEntityTypesApi() [1/4]

Lusid.Sdk.Api.CustomEntityTypesApi.CustomEntityTypesApi ( )

inline

Initializes a new instance of the CustomEntityTypesApi class.

Returns

◆ CustomEntityTypesApi() [2/4]

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

inline

Initializes a new instance of the CustomEntityTypesApi class.

Returns

◆ CustomEntityTypesApi() [3/4]

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

inline

Initializes a new instance of the CustomEntityTypesApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ CustomEntityTypesApi() [4/4]

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

inline

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

◆ CreateCustomEntityType()

CustomEntityType Lusid.Sdk.Api.CustomEntityTypesApi.CreateCustomEntityType	(	CreateCustomEntityTypeRequest	createCustomEntityTypeRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] CreateCustomEntityType: 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

createCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.

Returns: CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ CreateCustomEntityTypeAsync()

async System.Threading.Tasks.Task<CustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.CreateCustomEntityTypeAsync	(	CreateCustomEntityTypeRequest	createCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] CreateCustomEntityType: 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

createCustomEntityTypeRequest	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 CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

◆ CreateCustomEntityTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.CreateCustomEntityTypeWithHttpInfo	(	CreateCustomEntityTypeRequest	createCustomEntityTypeRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] CreateCustomEntityType: 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

createCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.

Returns: ApiResponse of CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ CreateCustomEntityTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityType> > Lusid.Sdk.Api.CustomEntityTypesApi.CreateCustomEntityTypeWithHttpInfoAsync	(	CreateCustomEntityTypeRequest	createCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] CreateCustomEntityType: 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

createCustomEntityTypeRequest	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 (CustomEntityType)

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetCustomEntityType()

CustomEntityType Lusid.Sdk.Api.CustomEntityTypesApi.GetCustomEntityType	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type 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.

Returns: CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ GetCustomEntityTypeAsync()

async System.Threading.Tasks.Task<CustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.GetCustomEntityTypeAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type 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 CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

◆ GetCustomEntityTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.GetCustomEntityTypeWithHttpInfo	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type 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.

Returns: ApiResponse of CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ GetCustomEntityTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityType> > Lusid.Sdk.Api.CustomEntityTypesApi.GetCustomEntityTypeWithHttpInfoAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. Retrieve a specific Custom Entity Type 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 (CustomEntityType)

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

◆ ListCustomEntityTypes()

PagedResourceListOfCustomEntityType Lusid.Sdk.Api.CustomEntityTypesApi.ListCustomEntityTypes	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types 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 Custom Entity Type 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)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (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, sortBy, and asAt fields must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfCustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ ListCustomEntityTypesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfCustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.ListCustomEntityTypesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types 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 Custom Entity Type 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)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (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, sortBy, 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 PagedResourceListOfCustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

◆ ListCustomEntityTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.ListCustomEntityTypesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types 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 Custom Entity Type 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)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (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, sortBy, and asAt fields must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfCustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ ListCustomEntityTypesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCustomEntityType> > Lusid.Sdk.Api.CustomEntityTypesApi.ListCustomEntityTypesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. List all Custom Entity Types 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 Custom Entity Type 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)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (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, sortBy, 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 (PagedResourceListOfCustomEntityType)

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

◆ UpdateCustomEntityType()

CustomEntityType Lusid.Sdk.Api.CustomEntityTypesApi.UpdateCustomEntityType	(	string	entityType,
		UpdateCustomEntityTypeRequest	updateCustomEntityTypeRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateCustomEntityType: 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.
updateCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.

Returns: CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ UpdateCustomEntityTypeAsync()

async System.Threading.Tasks.Task<CustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.UpdateCustomEntityTypeAsync	(	string	entityType,
		UpdateCustomEntityTypeRequest	updateCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateCustomEntityType: 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.
updateCustomEntityTypeRequest	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 CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

◆ UpdateCustomEntityTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomEntityType> Lusid.Sdk.Api.CustomEntityTypesApi.UpdateCustomEntityTypeWithHttpInfo	(	string	entityType,
		UpdateCustomEntityTypeRequest	updateCustomEntityTypeRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateCustomEntityType: 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.
updateCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.

Returns: ApiResponse of CustomEntityType

Implements Lusid.Sdk.Api.ICustomEntityTypesApiSync.

◆ UpdateCustomEntityTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityType> > Lusid.Sdk.Api.CustomEntityTypesApi.UpdateCustomEntityTypeWithHttpInfoAsync	(	string	entityType,
		UpdateCustomEntityTypeRequest	updateCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateCustomEntityType: 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.
updateCustomEntityTypeRequest	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 (CustomEntityType)

Implements Lusid.Sdk.Api.ICustomEntityTypesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.CustomEntityTypesApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.CustomEntityTypesApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.CustomEntityTypesApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CustomEntityTypesApi() [1/4]

◆ CustomEntityTypesApi() [2/4]

◆ CustomEntityTypesApi() [3/4]

◆ CustomEntityTypesApi() [4/4]

Member Function Documentation

◆ CreateCustomEntityType()

◆ CreateCustomEntityTypeAsync()

◆ CreateCustomEntityTypeWithHttpInfo()

◆ CreateCustomEntityTypeWithHttpInfoAsync()

◆ GetBasePath()

◆ GetCustomEntityType()

◆ GetCustomEntityTypeAsync()

◆ GetCustomEntityTypeWithHttpInfo()

◆ GetCustomEntityTypeWithHttpInfoAsync()

◆ ListCustomEntityTypes()

◆ ListCustomEntityTypesAsync()

◆ ListCustomEntityTypesWithHttpInfo()

◆ ListCustomEntityTypesWithHttpInfoAsync()

◆ UpdateCustomEntityType()

◆ UpdateCustomEntityTypeAsync()

◆ UpdateCustomEntityTypeWithHttpInfo()

◆ UpdateCustomEntityTypeWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory