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

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

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

Public Member Functions

System.Threading.Tasks.Task< PropertyDefinitionCreateDerivedPropertyDefinitionAsync (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition More...
 
System.Threading.Tasks.Task< ApiResponse< PropertyDefinition > > CreateDerivedPropertyDefinitionWithHttpInfoAsync (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition More...
 
System.Threading.Tasks.Task< PropertyDefinitionCreatePropertyDefinitionAsync (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreatePropertyDefinition: Create property definition More...
 
System.Threading.Tasks.Task< ApiResponse< PropertyDefinition > > CreatePropertyDefinitionWithHttpInfoAsync (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreatePropertyDefinition: Create property definition More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeletePropertyDefinitionAsync (string domain, string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeletePropertyDefinition: Delete property definition More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeletePropertyDefinitionWithHttpInfoAsync (string domain, string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeletePropertyDefinition: Delete property definition More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeletePropertyDefinitionPropertiesAsync (string domain, string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeletePropertyDefinitionPropertiesWithHttpInfoAsync (string domain, string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties More...
 
System.Threading.Tasks.Task< ResourceListOfPropertyDefinitionGetMultiplePropertyDefinitionsAsync (List< string > propertyKeys, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetMultiplePropertyDefinitions: Get multiple property definitions More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfPropertyDefinition > > GetMultiplePropertyDefinitionsWithHttpInfoAsync (List< string > propertyKeys, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetMultiplePropertyDefinitions: Get multiple property definitions More...
 
System.Threading.Tasks.Task< PropertyDefinitionGetPropertyDefinitionAsync (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPropertyDefinition: Get property definition More...
 
System.Threading.Tasks.Task< ApiResponse< PropertyDefinition > > GetPropertyDefinitionWithHttpInfoAsync (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPropertyDefinition: Get property definition More...
 
System.Threading.Tasks.Task< ResourceListOfPropertyIntervalGetPropertyDefinitionPropertyTimeSeriesAsync (string domain, string scope, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfPropertyInterval > > GetPropertyDefinitionPropertyTimeSeriesWithHttpInfoAsync (string domain, string scope, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series More...
 
System.Threading.Tasks.Task< PagedResourceListOfPropertyDefinitionListPropertyDefinitionsAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), 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))
 ListPropertyDefinitions: List property definitions More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfPropertyDefinition > > ListPropertyDefinitionsWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), 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))
 ListPropertyDefinitions: List property definitions More...
 
System.Threading.Tasks.Task< PropertyDefinitionUpdateDerivedPropertyDefinitionAsync (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition More...
 
System.Threading.Tasks.Task< ApiResponse< PropertyDefinition > > UpdateDerivedPropertyDefinitionWithHttpInfoAsync (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition More...
 
System.Threading.Tasks.Task< PropertyDefinitionUpdatePropertyDefinitionAsync (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpdatePropertyDefinition: Update property definition More...
 
System.Threading.Tasks.Task< ApiResponse< PropertyDefinition > > UpdatePropertyDefinitionWithHttpInfoAsync (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpdatePropertyDefinition: Update property definition More...
 
System.Threading.Tasks.Task< BatchUpsertPropertyDefinitionPropertiesResponseUpsertPropertyDefinitionPropertiesAsync (string domain, string scope, string code, Dictionary< string, Property > requestBody, string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertPropertyDefinitionProperties: Upsert properties to a property definition More...
 
System.Threading.Tasks.Task< ApiResponse< BatchUpsertPropertyDefinitionPropertiesResponse > > UpsertPropertyDefinitionPropertiesWithHttpInfoAsync (string domain, string scope, string code, Dictionary< string, Property > requestBody, string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertPropertyDefinitionProperties: Upsert properties to a property definition More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateDerivedPropertyDefinitionAsync()

System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.CreateDerivedPropertyDefinitionAsync ( CreateDerivedPropertyDefinitionRequest  createDerivedPropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition

Define a new derived property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createDerivedPropertyDefinitionRequestThe definition of the new derived property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreateDerivedPropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.CreateDerivedPropertyDefinitionWithHttpInfoAsync ( CreateDerivedPropertyDefinitionRequest  createDerivedPropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition

Define a new derived property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createDerivedPropertyDefinitionRequestThe definition of the new derived property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PropertyDefinition)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinitionAsync()

System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.CreatePropertyDefinitionAsync ( CreatePropertyDefinitionRequest  createPropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CreatePropertyDefinition: Create property definition

Define a new property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createPropertyDefinitionRequestThe definition of the new property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.CreatePropertyDefinitionWithHttpInfoAsync ( CreatePropertyDefinitionRequest  createPropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CreatePropertyDefinition: Create property definition

Define a new property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createPropertyDefinitionRequestThe definition of the new property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PropertyDefinition)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.DeletePropertyDefinitionAsync ( string  domain,
string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

DeletePropertyDefinition: Delete property definition

Delete the definition of the specified property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property to be deleted.
scopeThe scope of the property to be deleted.
codeThe code of the property to be deleted. Together with the domain and scope this uniquely identifies the property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionPropertiesAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.DeletePropertyDefinitionPropertiesAsync ( string  domain,
string  scope,
string  code,
List< string >  requestBody,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties

Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property definition to delete properties from.
scopeThe scope of the property definition to delete properties from.
codeThe code of the property definition to delete properties from.
requestBodyThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g &quot;PropertyDefinition/myScope/someAttributeKey&quot;. Each property must be from the &quot;PropertyDefinition&quot; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.DeletePropertyDefinitionPropertiesWithHttpInfoAsync ( string  domain,
string  scope,
string  code,
List< string >  requestBody,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties

Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property definition to delete properties from.
scopeThe scope of the property definition to delete properties from.
codeThe code of the property definition to delete properties from.
requestBodyThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g &quot;PropertyDefinition/myScope/someAttributeKey&quot;. Each property must be from the &quot;PropertyDefinition&quot; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.DeletePropertyDefinitionWithHttpInfoAsync ( string  domain,
string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

DeletePropertyDefinition: Delete property definition

Delete the definition of the specified property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property to be deleted.
scopeThe scope of the property to be deleted.
codeThe code of the property to be deleted. Together with the domain and scope this uniquely identifies the property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetMultiplePropertyDefinitionsAsync()

System.Threading.Tasks.Task<ResourceListOfPropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.GetMultiplePropertyDefinitionsAsync ( List< string >  propertyKeys,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetMultiplePropertyDefinitions: Get multiple property definitions

Retrieve the definition of one or more specified properties.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
propertyKeysOne or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. &#39;Portfolio/Manager/Id&#39;.
asAtThe asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Lifetime, use &quot;lifeTime eq &#39;Perpetual&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
effectiveAtThe effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetMultiplePropertyDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.GetMultiplePropertyDefinitionsWithHttpInfoAsync ( List< string >  propertyKeys,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetMultiplePropertyDefinitions: Get multiple property definitions

Retrieve the definition of one or more specified properties.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
propertyKeysOne or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. &#39;Portfolio/Manager/Id&#39;.
asAtThe asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Lifetime, use &quot;lifeTime eq &#39;Perpetual&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
effectiveAtThe effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPropertyDefinition)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionAsync()

System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.GetPropertyDefinitionAsync ( string  domain,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetPropertyDefinition: Get property definition

Retrieve the definition of a specified property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the specified property.
scopeThe scope of the specified property.
codeThe code of the specified property. Together with the domain and scope this uniquely identifies the property.
asAtThe asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAtThe effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionPropertyTimeSeriesAsync()

System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.GetPropertyDefinitionPropertyTimeSeriesAsync ( string  domain,
string  scope,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series

List the complete time series of a property definition property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property definition to which the property is attached
scopeThe scope of the property definition to which the property is attached
codeThe code of the property definition to which the property is attached
propertyKeyThe property key of the property whose history to show. This must be from the &quot;Property Definition&quot; domain and in the format {domain}/{scope}/{code}, for example &quot;PropertyDefinition/myScope/someAttributeKey&quot;.
asAtThe asAt datetime at which to show the history. Defaults to the current datetime if not specified. (optional)
filterExpression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionPropertyTimeSeriesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.GetPropertyDefinitionPropertyTimeSeriesWithHttpInfoAsync ( string  domain,
string  scope,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series

List the complete time series of a property definition property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property definition to which the property is attached
scopeThe scope of the property definition to which the property is attached
codeThe code of the property definition to which the property is attached
propertyKeyThe property key of the property whose history to show. This must be from the &quot;Property Definition&quot; domain and in the format {domain}/{scope}/{code}, for example &quot;PropertyDefinition/myScope/someAttributeKey&quot;.
asAtThe asAt datetime at which to show the history. Defaults to the current datetime if not specified. (optional)
filterExpression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPropertyInterval)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.GetPropertyDefinitionWithHttpInfoAsync ( string  domain,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetPropertyDefinition: Get property definition

Retrieve the definition of a specified property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the specified property.
scopeThe scope of the specified property.
codeThe code of the specified property. Together with the domain and scope this uniquely identifies the property.
asAtThe asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAtThe effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PropertyDefinition)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ ListPropertyDefinitionsAsync()

System.Threading.Tasks.Task<PagedResourceListOfPropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.ListPropertyDefinitionsAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
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) 
)

ListPropertyDefinitions: List property definitions

List all the property definitions matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Property Definition&#39; domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g &quot;PropertyDefinition/myScope/someAttributeKey&quot;. Each property must be from the &quot;PropertyDefinition&quot; domain. (optional)
pageThe pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the display name, specify &quot;DisplayName eq &#39;DisplayName&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfPropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ ListPropertyDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfPropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.ListPropertyDefinitionsWithHttpInfoAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
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) 
)

ListPropertyDefinitions: List property definitions

List all the property definitions matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Property Definition&#39; domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g &quot;PropertyDefinition/myScope/someAttributeKey&quot;. Each property must be from the &quot;PropertyDefinition&quot; domain. (optional)
pageThe pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the display name, specify &quot;DisplayName eq &#39;DisplayName&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfPropertyDefinition)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdateDerivedPropertyDefinitionAsync()

System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.UpdateDerivedPropertyDefinitionAsync ( string  domain,
string  scope,
string  code,
UpdateDerivedPropertyDefinitionRequest  updateDerivedPropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition

This will fail if the property definition does not exist

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainDomain of the property definition
scopeScope of the property definition
codeCode of the property definition
updateDerivedPropertyDefinitionRequestInformation about the derived property definition being updated
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdateDerivedPropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.UpdateDerivedPropertyDefinitionWithHttpInfoAsync ( string  domain,
string  scope,
string  code,
UpdateDerivedPropertyDefinitionRequest  updateDerivedPropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition

This will fail if the property definition does not exist

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainDomain of the property definition
scopeScope of the property definition
codeCode of the property definition
updateDerivedPropertyDefinitionRequestInformation about the derived property definition being updated
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PropertyDefinition)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdatePropertyDefinitionAsync()

System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.UpdatePropertyDefinitionAsync ( string  domain,
string  scope,
string  code,
UpdatePropertyDefinitionRequest  updatePropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpdatePropertyDefinition: Update property definition

Update the definition of a specified existing property. Not all elements within a property definition are modifiable due to the potential implications for values already stored against the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property being updated.
scopeThe scope of the property being updated.
codeThe code of the property being updated. Together with the domain and scope this uniquely identifies the property.
updatePropertyDefinitionRequestThe updated definition of the property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdatePropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.UpdatePropertyDefinitionWithHttpInfoAsync ( string  domain,
string  scope,
string  code,
UpdatePropertyDefinitionRequest  updatePropertyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpdatePropertyDefinition: Update property definition

Update the definition of a specified existing property. Not all elements within a property definition are modifiable due to the potential implications for values already stored against the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the property being updated.
scopeThe scope of the property being updated.
codeThe code of the property being updated. Together with the domain and scope this uniquely identifies the property.
updatePropertyDefinitionRequestThe updated definition of the property.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PropertyDefinition)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpsertPropertyDefinitionPropertiesAsync()

System.Threading.Tasks.Task<BatchUpsertPropertyDefinitionPropertiesResponse> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.UpsertPropertyDefinitionPropertiesAsync ( string  domain,
string  scope,
string  code,
Dictionary< string, Property requestBody,
string?  successMode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertPropertyDefinitionProperties: Upsert properties to a property definition

Create or update properties for a particular property definition

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the specified property.
scopeThe scope of the specified property.
codeThe code of the specified property. Together with the domain and scope this uniquely
requestBodyThe properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example &#39;PropertyDefinition/Manager/Id&#39;.
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial")
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of BatchUpsertPropertyDefinitionPropertiesResponse

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpsertPropertyDefinitionPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<BatchUpsertPropertyDefinitionPropertiesResponse> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.UpsertPropertyDefinitionPropertiesWithHttpInfoAsync ( string  domain,
string  scope,
string  code,
Dictionary< string, Property requestBody,
string?  successMode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertPropertyDefinitionProperties: Upsert properties to a property definition

Create or update properties for a particular property definition

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
domainThe domain of the specified property.
scopeThe scope of the specified property.
codeThe code of the specified property. Together with the domain and scope this uniquely
requestBodyThe properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example &#39;PropertyDefinition/Manager/Id&#39;.
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial")
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (BatchUpsertPropertyDefinitionPropertiesResponse)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.


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