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

Inheritance diagram for Lusid.Sdk.Api.IEntitiesApiAsync:

[legend]

Public Member Functions
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)
	[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId More...

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)
	[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId More...

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)
	[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId More...

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)
	[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId More...

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)
	[EXPERIMENTAL] GetEntityHistory: List an entity's history information More...

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)
	[EXPERIMENTAL] GetEntityHistory: List an entity's history information More...

System.Threading.Tasks.Task< InstrumentEntity >	GetInstrumentByEntityUniqueIdAsync (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)
	[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId More...

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 >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId More...

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)
	[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId More...

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)
	[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId More...

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. More...

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. More...

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)
	[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId More...

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)
	[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ GetCustomEntityByEntityUniqueIdAsync()

System.Threading.Tasks.Task<CustomEntityEntity> Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetCustomEntityByEntityUniqueIdWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityEntity> > Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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)

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetDataTypeByEntityUniqueIdAsync()

System.Threading.Tasks.Task<DataTypeEntity> Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetDataTypeByEntityUniqueIdWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DataTypeEntity> > Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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)

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetEntityHistoryAsync()

System.Threading.Tasks.Task<ResourceListOfChangeInterval> Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetEntityHistoryWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfChangeInterval> > Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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)

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetInstrumentByEntityUniqueIdAsync()

System.Threading.Tasks.Task<InstrumentEntity> Lusid.Sdk.Api.IEntitiesApiAsync.GetInstrumentByEntityUniqueIdAsync	(	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`
	)

[EXPERIMENTAL] 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)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of InstrumentEntity

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetInstrumentByEntityUniqueIdWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<InstrumentEntity> > Lusid.Sdk.Api.IEntitiesApiAsync.GetInstrumentByEntityUniqueIdWithHttpInfoAsync	(	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`
	)

[EXPERIMENTAL] 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)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (InstrumentEntity)

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPortfolioByEntityUniqueIdAsync()

System.Threading.Tasks.Task<PortfolioEntity> Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPortfolioByEntityUniqueIdWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PortfolioEntity> > Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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)

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPortfolioChangesAsync()

System.Threading.Tasks.Task<ResourceListOfChange> Lusid.Sdk.Api.IEntitiesApiAsync.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).

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

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPortfolioChangesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfChange> > Lusid.Sdk.Api.IEntitiesApiAsync.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).

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)

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPropertyDefinitionByEntityUniqueIdAsync()

System.Threading.Tasks.Task<PropertyDefinitionEntity> Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPropertyDefinitionByEntityUniqueIdWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PropertyDefinitionEntity> > Lusid.Sdk.Api.IEntitiesApiAsync.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`
	)

[EXPERIMENTAL] 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)

Implemented in Lusid.Sdk.Api.EntitiesApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/EntitiesApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetCustomEntityByEntityUniqueIdAsync()

◆ GetCustomEntityByEntityUniqueIdWithHttpInfoAsync()

◆ GetDataTypeByEntityUniqueIdAsync()

◆ GetDataTypeByEntityUniqueIdWithHttpInfoAsync()

◆ GetEntityHistoryAsync()

◆ GetEntityHistoryWithHttpInfoAsync()

◆ GetInstrumentByEntityUniqueIdAsync()

◆ GetInstrumentByEntityUniqueIdWithHttpInfoAsync()

◆ GetPortfolioByEntityUniqueIdAsync()

◆ GetPortfolioByEntityUniqueIdWithHttpInfoAsync()

◆ GetPortfolioChangesAsync()

◆ GetPortfolioChangesWithHttpInfoAsync()

◆ GetPropertyDefinitionByEntityUniqueIdAsync()

◆ GetPropertyDefinitionByEntityUniqueIdWithHttpInfoAsync()