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

Inheritance diagram for Lusid.Sdk.Api.EntitiesApi:

[legend]

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

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

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

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

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

CustomEntityEntity	GetCustomEntityByEntityUniqueId (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. More...

Lusid.Sdk.Client.ApiResponse< CustomEntityEntity >	GetCustomEntityByEntityUniqueIdWithHttpInfo (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. More...

async System.Threading.Tasks.Task< CustomEntityEntity >	GetCustomEntityByEntityUniqueIdAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomEntityEntity > >	GetCustomEntityByEntityUniqueIdWithHttpInfoAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. More...

DataTypeEntity	GetDataTypeByEntityUniqueId (string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. More...

Lusid.Sdk.Client.ApiResponse< DataTypeEntity >	GetDataTypeByEntityUniqueIdWithHttpInfo (string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. More...

async System.Threading.Tasks.Task< DataTypeEntity >	GetDataTypeByEntityUniqueIdAsync (string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DataTypeEntity > >	GetDataTypeByEntityUniqueIdWithHttpInfoAsync (string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. More...

ResourceListOfChangeInterval	GetEntityHistory (string entityType, string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfChangeInterval >	GetEntityHistoryWithHttpInfo (string entityType, string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time. More...

async System.Threading.Tasks.Task< ResourceListOfChangeInterval >	GetEntityHistoryAsync (string entityType, string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfChangeInterval > >	GetEntityHistoryWithHttpInfoAsync (string entityType, string entityUniqueId, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time. More...

InstrumentEntity	GetInstrumentByEntityUniqueId (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), string? dataModelScope=default(string?), string? dataModelCode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. More...

Lusid.Sdk.Client.ApiResponse< InstrumentEntity >	GetInstrumentByEntityUniqueIdWithHttpInfo (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), string? dataModelScope=default(string?), string? dataModelCode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. More...

async System.Threading.Tasks.Task< InstrumentEntity >	GetInstrumentByEntityUniqueIdAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), string? dataModelScope=default(string?), string? dataModelCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< InstrumentEntity > >	GetInstrumentByEntityUniqueIdWithHttpInfoAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), string? dataModelScope=default(string?), string? dataModelCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. More...

PortfolioEntity	GetPortfolioByEntityUniqueId (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...

Lusid.Sdk.Client.ApiResponse< PortfolioEntity >	GetPortfolioByEntityUniqueIdWithHttpInfo (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...

async System.Threading.Tasks.Task< PortfolioEntity >	GetPortfolioByEntityUniqueIdAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioEntity > >	GetPortfolioByEntityUniqueIdWithHttpInfoAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...

ResourceListOfChange	GetPortfolioChanges (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfChange >	GetPortfolioChangesWithHttpInfo (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). More...

async System.Threading.Tasks.Task< ResourceListOfChange >	GetPortfolioChangesAsync (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfChange > >	GetPortfolioChangesWithHttpInfoAsync (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). More...

PropertyDefinitionEntity	GetPropertyDefinitionByEntityUniqueId (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. More...

Lusid.Sdk.Client.ApiResponse< PropertyDefinitionEntity >	GetPropertyDefinitionByEntityUniqueIdWithHttpInfo (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. More...

async System.Threading.Tasks.Task< PropertyDefinitionEntity >	GetPropertyDefinitionByEntityUniqueIdAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PropertyDefinitionEntity > >	GetPropertyDefinitionByEntityUniqueIdWithHttpInfoAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. 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

◆ EntitiesApi() [1/4]

Lusid.Sdk.Api.EntitiesApi.EntitiesApi ( )

inline

Initializes a new instance of the EntitiesApi class.

Returns

◆ EntitiesApi() [2/4]

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

inline

Initializes a new instance of the EntitiesApi class.

Returns

◆ EntitiesApi() [3/4]

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

inline

Initializes a new instance of the EntitiesApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ EntitiesApi() [4/4]

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

inline

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

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ GetCustomEntityByEntityUniqueId()

CustomEntityEntity Lusid.Sdk.Api.EntitiesApi.GetCustomEntityByEntityUniqueId	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the Custom Entity.
effectiveAt	The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CustomEntityEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetCustomEntityByEntityUniqueIdAsync()

async System.Threading.Tasks.Task<CustomEntityEntity> Lusid.Sdk.Api.EntitiesApi.GetCustomEntityByEntityUniqueIdAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the Custom Entity.
effectiveAt	The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CustomEntityEntity

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetCustomEntityByEntityUniqueIdWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomEntityEntity> Lusid.Sdk.Api.EntitiesApi.GetCustomEntityByEntityUniqueIdWithHttpInfo	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the Custom Entity.
effectiveAt	The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CustomEntityEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetCustomEntityByEntityUniqueIdWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityEntity> > Lusid.Sdk.Api.EntitiesApi.GetCustomEntityByEntityUniqueIdWithHttpInfoAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the Custom Entity.
effectiveAt	The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CustomEntityEntity)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetDataTypeByEntityUniqueId()

DataTypeEntity Lusid.Sdk.Api.EntitiesApi.GetDataTypeByEntityUniqueId	(	string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the DataType definition.
asAt	The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DataTypeEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetDataTypeByEntityUniqueIdAsync()

async System.Threading.Tasks.Task<DataTypeEntity> Lusid.Sdk.Api.EntitiesApi.GetDataTypeByEntityUniqueIdAsync	(	string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the DataType definition.
asAt	The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DataTypeEntity

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetDataTypeByEntityUniqueIdWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataTypeEntity> Lusid.Sdk.Api.EntitiesApi.GetDataTypeByEntityUniqueIdWithHttpInfo	(	string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the DataType definition.
asAt	The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DataTypeEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetDataTypeByEntityUniqueIdWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DataTypeEntity> > Lusid.Sdk.Api.EntitiesApi.GetDataTypeByEntityUniqueIdWithHttpInfoAsync	(	string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the DataType definition.
asAt	The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DataTypeEntity)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetEntityHistory()

ResourceListOfChangeInterval Lusid.Sdk.Api.EntitiesApi.GetEntityHistory	(	string	entityType,
		string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time.

Exceptions

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

Parameters

entityType	The type of the entity to list the change history for.
entityUniqueId	The universally unique identifier of the entity.
asAt	The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified. (optional)
page	The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfChangeInterval

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetEntityHistoryAsync()

async System.Threading.Tasks.Task<ResourceListOfChangeInterval> Lusid.Sdk.Api.EntitiesApi.GetEntityHistoryAsync	(	string	entityType,
		string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time.

Exceptions

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

Parameters

entityType	The type of the entity to list the change history for.
entityUniqueId	The universally unique identifier of the entity.
asAt	The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified. (optional)
page	The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names 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 ResourceListOfChangeInterval

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetEntityHistoryWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfChangeInterval> Lusid.Sdk.Api.EntitiesApi.GetEntityHistoryWithHttpInfo	(	string	entityType,
		string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time.

Exceptions

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

Parameters

entityType	The type of the entity to list the change history for.
entityUniqueId	The universally unique identifier of the entity.
asAt	The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified. (optional)
page	The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfChangeInterval

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetEntityHistoryWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfChangeInterval> > Lusid.Sdk.Api.EntitiesApi.GetEntityHistoryWithHttpInfoAsync	(	string	entityType,
		string	entityUniqueId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetEntityHistory: List an entity's history information Retrieve a page of an entity's change history up to a particular point in AsAt time.

Exceptions

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

Parameters

entityType	The type of the entity to list the change history for.
entityUniqueId	The universally unique identifier of the entity.
asAt	The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified. (optional)
page	The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names 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 (ResourceListOfChangeInterval)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetInstrumentByEntityUniqueId()

InstrumentEntity Lusid.Sdk.Api.EntitiesApi.GetInstrumentByEntityUniqueId	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		string?	dataModelScope = `default(string?)`,
		string?	dataModelCode = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the instrument definition.
effectiveAt	The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
dataModelScope	The optional scope of a Custom Data Model to use. (optional)
dataModelCode	The optional code of a Custom Data Model to use. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: InstrumentEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetInstrumentByEntityUniqueIdAsync()

async System.Threading.Tasks.Task<InstrumentEntity> Lusid.Sdk.Api.EntitiesApi.GetInstrumentByEntityUniqueIdAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		string?	dataModelScope = `default(string?)`,
		string?	dataModelCode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the instrument definition.
effectiveAt	The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
dataModelScope	The optional scope of a Custom Data Model to use. (optional)
dataModelCode	The optional code of a Custom Data Model to use. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of InstrumentEntity

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetInstrumentByEntityUniqueIdWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<InstrumentEntity> Lusid.Sdk.Api.EntitiesApi.GetInstrumentByEntityUniqueIdWithHttpInfo	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		string?	dataModelScope = `default(string?)`,
		string?	dataModelCode = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the instrument definition.
effectiveAt	The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
dataModelScope	The optional scope of a Custom Data Model to use. (optional)
dataModelCode	The optional code of a Custom Data Model to use. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of InstrumentEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetInstrumentByEntityUniqueIdWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<InstrumentEntity> > Lusid.Sdk.Api.EntitiesApi.GetInstrumentByEntityUniqueIdWithHttpInfoAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		string?	dataModelScope = `default(string?)`,
		string?	dataModelCode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the instrument definition.
effectiveAt	The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
dataModelScope	The optional scope of a Custom Data Model to use. (optional)
dataModelCode	The optional code of a Custom Data Model to use. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (InstrumentEntity)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPortfolioByEntityUniqueId()

PortfolioEntity Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueId	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the portfolio definition.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PortfolioEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioByEntityUniqueIdAsync()

async System.Threading.Tasks.Task<PortfolioEntity> Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueIdAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the portfolio definition.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PortfolioEntity

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPortfolioByEntityUniqueIdWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioEntity> Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueIdWithHttpInfo	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the portfolio definition.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PortfolioEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioByEntityUniqueIdWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PortfolioEntity> > Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueIdWithHttpInfoAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the portfolio definition.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PortfolioEntity)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPortfolioChanges()

ResourceListOfChange Lusid.Sdk.Api.EntitiesApi.GetPortfolioChanges	(	string	scope,
		DateTimeOrCutLabel	effectiveAt,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions

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

Parameters

scope	The scope
effectiveAt	The effective date of the origin.
asAt	The as-at date of the origin. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfChange

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioChangesAsync()

async System.Threading.Tasks.Task<ResourceListOfChange> Lusid.Sdk.Api.EntitiesApi.GetPortfolioChangesAsync	(	string	scope,
		DateTimeOrCutLabel	effectiveAt,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions

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

Parameters

scope	The scope
effectiveAt	The effective date of the origin.
asAt	The as-at date of the origin. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfChange

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPortfolioChangesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfChange> Lusid.Sdk.Api.EntitiesApi.GetPortfolioChangesWithHttpInfo	(	string	scope,
		DateTimeOrCutLabel	effectiveAt,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions

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

Parameters

scope	The scope
effectiveAt	The effective date of the origin.
asAt	The as-at date of the origin. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfChange

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioChangesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfChange> > Lusid.Sdk.Api.EntitiesApi.GetPortfolioChangesWithHttpInfoAsync	(	string	scope,
		DateTimeOrCutLabel	effectiveAt,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions

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

Parameters

scope	The scope
effectiveAt	The effective date of the origin.
asAt	The as-at date of the origin. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfChange)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPropertyDefinitionByEntityUniqueId()

PropertyDefinitionEntity Lusid.Sdk.Api.EntitiesApi.GetPropertyDefinitionByEntityUniqueId	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the property definition.
effectiveAt	The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PropertyDefinitionEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPropertyDefinitionByEntityUniqueIdAsync()

async System.Threading.Tasks.Task<PropertyDefinitionEntity> Lusid.Sdk.Api.EntitiesApi.GetPropertyDefinitionByEntityUniqueIdAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the property definition.
effectiveAt	The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PropertyDefinitionEntity

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPropertyDefinitionByEntityUniqueIdWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinitionEntity> Lusid.Sdk.Api.EntitiesApi.GetPropertyDefinitionByEntityUniqueIdWithHttpInfo	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the property definition.
effectiveAt	The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PropertyDefinitionEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPropertyDefinitionByEntityUniqueIdWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PropertyDefinitionEntity> > Lusid.Sdk.Api.EntitiesApi.GetPropertyDefinitionByEntityUniqueIdWithHttpInfoAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	previews = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the property definition.
effectiveAt	The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified. (optional)
previews	The ids of the staged modifications to be previewed in the response. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PropertyDefinitionEntity)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.EntitiesApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.EntitiesApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.EntitiesApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EntitiesApi() [1/4]

◆ EntitiesApi() [2/4]

◆ EntitiesApi() [3/4]

◆ EntitiesApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ GetCustomEntityByEntityUniqueId()

◆ GetCustomEntityByEntityUniqueIdAsync()

◆ GetCustomEntityByEntityUniqueIdWithHttpInfo()

◆ GetCustomEntityByEntityUniqueIdWithHttpInfoAsync()

◆ GetDataTypeByEntityUniqueId()

◆ GetDataTypeByEntityUniqueIdAsync()

◆ GetDataTypeByEntityUniqueIdWithHttpInfo()

◆ GetDataTypeByEntityUniqueIdWithHttpInfoAsync()

◆ GetEntityHistory()

◆ GetEntityHistoryAsync()

◆ GetEntityHistoryWithHttpInfo()

◆ GetEntityHistoryWithHttpInfoAsync()

◆ GetInstrumentByEntityUniqueId()

◆ GetInstrumentByEntityUniqueIdAsync()

◆ GetInstrumentByEntityUniqueIdWithHttpInfo()

◆ GetInstrumentByEntityUniqueIdWithHttpInfoAsync()

◆ GetPortfolioByEntityUniqueId()

◆ GetPortfolioByEntityUniqueIdAsync()

◆ GetPortfolioByEntityUniqueIdWithHttpInfo()

◆ GetPortfolioByEntityUniqueIdWithHttpInfoAsync()

◆ GetPortfolioChanges()

◆ GetPortfolioChangesAsync()

◆ GetPortfolioChangesWithHttpInfo()

◆ GetPortfolioChangesWithHttpInfoAsync()

◆ GetPropertyDefinitionByEntityUniqueId()

◆ GetPropertyDefinitionByEntityUniqueIdAsync()

◆ GetPropertyDefinitionByEntityUniqueIdWithHttpInfo()

◆ GetPropertyDefinitionByEntityUniqueIdWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory