LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IEntitiesApiAsync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IEntitiesApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< CustomEntityEntityGetCustomEntityByEntityUniqueIdAsync (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< DataTypeEntityGetDataTypeByEntityUniqueIdAsync (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< ResourceListOfChangeIntervalGetEntityHistoryAsync (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&#39;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&#39;s history information More...
 
System.Threading.Tasks.Task< InstrumentEntityGetInstrumentByEntityUniqueIdAsync (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< PortfolioEntityGetPortfolioByEntityUniqueIdAsync (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< ResourceListOfChangeGetPortfolioChangesAsync (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< PropertyDefinitionEntityGetPropertyDefinitionByEntityUniqueIdAsync (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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the Custom Entity.
effectiveAtThe effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the Custom Entity.
effectiveAtThe effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the DataType definition.
asAtThe asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the DataType definition.
asAtThe asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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&#39;s history information

Retrieve a page of an entity&#39;s change history up to a particular point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe type of the entity to list the change history for.
entityUniqueIdThe universally unique identifier of the entity.
asAtThe asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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&#39;s history information

Retrieve a page of an entity&#39;s change history up to a particular point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe type of the entity to list the change history for.
entityUniqueIdThe universally unique identifier of the entity.
asAtThe asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the instrument definition.
effectiveAtThe effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the instrument definition.
effectiveAtThe effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the portfolio definition.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the portfolio definition.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope
effectiveAtThe effective date of the origin.
asAtThe as-at date of the origin. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope
effectiveAtThe effective date of the origin.
asAtThe as-at date of the origin. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the property definition.
effectiveAtThe effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the property definition.
effectiveAtThe effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions 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: