LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.PropertyDefinitionsApi Class Reference

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

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

Public Member Functions

 PropertyDefinitionsApi ()
 Initializes a new instance of the PropertyDefinitionsApi class. More...
 
 PropertyDefinitionsApi (string basePath)
 Initializes a new instance of the PropertyDefinitionsApi class. More...
 
 PropertyDefinitionsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the PropertyDefinitionsApi class using Configuration object More...
 
 PropertyDefinitionsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the PropertyDefinitionsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
PropertyDefinition CreateDerivedPropertyDefinition (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition Define a new derived property. More...
 
Lusid.Sdk.Client.ApiResponse< PropertyDefinitionCreateDerivedPropertyDefinitionWithHttpInfo (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition Define a new derived property. More...
 
async 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 Define a new derived property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PropertyDefinition > > 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. More...
 
PropertyDefinition CreatePropertyDefinition (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0)
 CreatePropertyDefinition: Create property definition Define a new property. More...
 
Lusid.Sdk.Client.ApiResponse< PropertyDefinitionCreatePropertyDefinitionWithHttpInfo (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0)
 CreatePropertyDefinition: Create property definition Define a new property. More...
 
async System.Threading.Tasks.Task< PropertyDefinitionCreatePropertyDefinitionAsync (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreatePropertyDefinition: Create property definition Define a new property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PropertyDefinition > > CreatePropertyDefinitionWithHttpInfoAsync (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreatePropertyDefinition: Create property definition Define a new property. More...
 
DeletedEntityResponse DeletePropertyDefinition (string domain, string scope, string code, int operationIndex=0)
 DeletePropertyDefinition: Delete property definition Delete the definition of the specified property. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePropertyDefinitionWithHttpInfo (string domain, string scope, string code, int operationIndex=0)
 DeletePropertyDefinition: Delete property definition Delete the definition of the specified property. More...
 
async 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 Delete the definition of the specified property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > 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. More...
 
DeletedEntityResponse DeletePropertyDefinitionProperties (string domain, string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePropertyDefinitionPropertiesWithHttpInfo (string domain, string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [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. More...
 
async 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 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...
 
ResourceListOfPropertyDefinition GetMultiplePropertyDefinitions (List< string > propertyKeys, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 GetMultiplePropertyDefinitions: Get multiple property definitions Retrieve the definition of one or more specified properties. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyDefinitionGetMultiplePropertyDefinitionsWithHttpInfo (List< string > propertyKeys, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 GetMultiplePropertyDefinitions: Get multiple property definitions Retrieve the definition of one or more specified properties. More...
 
async 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 Retrieve the definition of one or more specified properties. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Retrieve the definition of one or more specified properties. More...
 
PropertyDefinition GetPropertyDefinition (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 GetPropertyDefinition: Get property definition Retrieve the definition of a specified property. More...
 
Lusid.Sdk.Client.ApiResponse< PropertyDefinitionGetPropertyDefinitionWithHttpInfo (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 GetPropertyDefinition: Get property definition Retrieve the definition of a specified property. More...
 
async 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 Retrieve the definition of a specified property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Retrieve the definition of a specified property. More...
 
ResourceListOfPropertyInterval GetPropertyDefinitionPropertyTimeSeries (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)
 [EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series List the complete time series of a property definition property. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyIntervalGetPropertyDefinitionPropertyTimeSeriesWithHttpInfo (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)
 [EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series List the complete time series of a property definition property. More...
 
async 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 List the complete time series of a property definition property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List the complete time series of a property definition property. More...
 
PagedResourceListOfPropertyDefinition ListPropertyDefinitions (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)
 ListPropertyDefinitions: List property definitions List all the property definitions matching particular criteria. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPropertyDefinitionListPropertyDefinitionsWithHttpInfo (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)
 ListPropertyDefinitions: List property definitions List all the property definitions matching particular criteria. More...
 
async 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 List all the property definitions matching particular criteria. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the property definitions matching particular criteria. More...
 
PropertyDefinition UpdateDerivedPropertyDefinition (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition This will fail if the property definition does not exist More...
 
Lusid.Sdk.Client.ApiResponse< PropertyDefinitionUpdateDerivedPropertyDefinitionWithHttpInfo (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition This will fail if the property definition does not exist More...
 
async 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 This will fail if the property definition does not exist More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 This will fail if the property definition does not exist More...
 
PropertyDefinition UpdatePropertyDefinition (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0)
 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. More...
 
Lusid.Sdk.Client.ApiResponse< PropertyDefinitionUpdatePropertyDefinitionWithHttpInfo (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0)
 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. More...
 
async 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 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...
 
BatchUpsertPropertyDefinitionPropertiesResponse UpsertPropertyDefinitionProperties (string domain, string scope, string code, Dictionary< string, Property > requestBody, string? successMode=default(string?), int operationIndex=0)
 UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition More...
 
Lusid.Sdk.Client.ApiResponse< BatchUpsertPropertyDefinitionPropertiesResponseUpsertPropertyDefinitionPropertiesWithHttpInfo (string domain, string scope, string code, Dictionary< string, Property > requestBody, string? successMode=default(string?), int operationIndex=0)
 UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition More...
 
async 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 Create or update properties for a particular property definition More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Create or update properties for a particular property definition More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ PropertyDefinitionsApi() [1/4]

Lusid.Sdk.Api.PropertyDefinitionsApi.PropertyDefinitionsApi ( )
inline

Initializes a new instance of the PropertyDefinitionsApi class.

Returns

◆ PropertyDefinitionsApi() [2/4]

Lusid.Sdk.Api.PropertyDefinitionsApi.PropertyDefinitionsApi ( string  basePath)
inline

Initializes a new instance of the PropertyDefinitionsApi class.

Returns

◆ PropertyDefinitionsApi() [3/4]

Lusid.Sdk.Api.PropertyDefinitionsApi.PropertyDefinitionsApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the PropertyDefinitionsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ PropertyDefinitionsApi() [4/4]

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

Initializes a new instance of the PropertyDefinitionsApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ CreateDerivedPropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.CreateDerivedPropertyDefinition ( CreateDerivedPropertyDefinitionRequest  createDerivedPropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreateDerivedPropertyDefinitionAsync()

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

[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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ CreateDerivedPropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.CreateDerivedPropertyDefinitionWithHttpInfo ( CreateDerivedPropertyDefinitionRequest  createDerivedPropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreateDerivedPropertyDefinitionWithHttpInfoAsync()

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

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ CreatePropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.CreatePropertyDefinition ( CreatePropertyDefinitionRequest  createPropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

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.
Returns
PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreatePropertyDefinitionAsync()

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

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ CreatePropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.CreatePropertyDefinitionWithHttpInfo ( CreatePropertyDefinitionRequest  createPropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreatePropertyDefinitionWithHttpInfoAsync()

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

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)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ DeletePropertyDefinition()

DeletedEntityResponse Lusid.Sdk.Api.PropertyDefinitionsApi.DeletePropertyDefinition ( string  domain,
string  scope,
string  code,
int  operationIndex = 0 
)
inline

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.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ DeletePropertyDefinitionAsync()

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

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ DeletePropertyDefinitionProperties()

DeletedEntityResponse Lusid.Sdk.Api.PropertyDefinitionsApi.DeletePropertyDefinitionProperties ( string  domain,
string  scope,
string  code,
List< string >  requestBody,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[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.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ DeletePropertyDefinitionPropertiesAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ DeletePropertyDefinitionPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PropertyDefinitionsApi.DeletePropertyDefinitionPropertiesWithHttpInfo ( string  domain,
string  scope,
string  code,
List< string >  requestBody,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ DeletePropertyDefinitionPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ DeletePropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PropertyDefinitionsApi.DeletePropertyDefinitionWithHttpInfo ( string  domain,
string  scope,
string  code,
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ DeletePropertyDefinitionWithHttpInfoAsync()

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

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)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.PropertyDefinitionsApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetMultiplePropertyDefinitions()

ResourceListOfPropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.GetMultiplePropertyDefinitions ( List< string >  propertyKeys,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.
Returns
ResourceListOfPropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetMultiplePropertyDefinitionsAsync()

async System.Threading.Tasks.Task<ResourceListOfPropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetMultiplePropertyDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.GetMultiplePropertyDefinitionsWithHttpInfo ( List< string >  propertyKeys,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of ResourceListOfPropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetMultiplePropertyDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyDefinition> > Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetPropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinition ( string  domain,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.
Returns
PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetPropertyDefinitionAsync()

async System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetPropertyDefinitionPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinitionPropertyTimeSeries ( 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 
)
inline

[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.
Returns
ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetPropertyDefinitionPropertyTimeSeriesAsync()

async System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetPropertyDefinitionPropertyTimeSeriesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinitionPropertyTimeSeriesWithHttpInfo ( 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 
)
inline

[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.
Returns
ApiResponse of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetPropertyDefinitionPropertyTimeSeriesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetPropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinitionWithHttpInfo ( string  domain,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetPropertyDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ ListPropertyDefinitions()

PagedResourceListOfPropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.ListPropertyDefinitions ( 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 
)
inline

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.
Returns
PagedResourceListOfPropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ ListPropertyDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfPropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ ListPropertyDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.ListPropertyDefinitionsWithHttpInfo ( 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 
)
inline

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.
Returns
ApiResponse of PagedResourceListOfPropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ ListPropertyDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPropertyDefinition> > Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpdateDerivedPropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.UpdateDerivedPropertyDefinition ( string  domain,
string  scope,
string  code,
UpdateDerivedPropertyDefinitionRequest  updateDerivedPropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpdateDerivedPropertyDefinitionAsync()

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

[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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpdateDerivedPropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.UpdateDerivedPropertyDefinitionWithHttpInfo ( string  domain,
string  scope,
string  code,
UpdateDerivedPropertyDefinitionRequest  updateDerivedPropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpdateDerivedPropertyDefinitionWithHttpInfoAsync()

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

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpdatePropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.UpdatePropertyDefinition ( string  domain,
string  scope,
string  code,
UpdatePropertyDefinitionRequest  updatePropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

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.
Returns
PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpdatePropertyDefinitionAsync()

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

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpdatePropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.UpdatePropertyDefinitionWithHttpInfo ( string  domain,
string  scope,
string  code,
UpdatePropertyDefinitionRequest  updatePropertyDefinitionRequest,
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpdatePropertyDefinitionWithHttpInfoAsync()

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

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)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpsertPropertyDefinitionProperties()

BatchUpsertPropertyDefinitionPropertiesResponse Lusid.Sdk.Api.PropertyDefinitionsApi.UpsertPropertyDefinitionProperties ( string  domain,
string  scope,
string  code,
Dictionary< string, Property requestBody,
string?  successMode = default(string?),
int  operationIndex = 0 
)
inline

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.
Returns
BatchUpsertPropertyDefinitionPropertiesResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpsertPropertyDefinitionPropertiesAsync()

async System.Threading.Tasks.Task<BatchUpsertPropertyDefinitionPropertiesResponse> Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpsertPropertyDefinitionPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BatchUpsertPropertyDefinitionPropertiesResponse> Lusid.Sdk.Api.PropertyDefinitionsApi.UpsertPropertyDefinitionPropertiesWithHttpInfo ( string  domain,
string  scope,
string  code,
Dictionary< string, Property requestBody,
string?  successMode = default(string?),
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of BatchUpsertPropertyDefinitionPropertiesResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpsertPropertyDefinitionPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BatchUpsertPropertyDefinitionPropertiesResponse> > Lusid.Sdk.Api.PropertyDefinitionsApi.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) 
)
inline

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)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.PropertyDefinitionsApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.PropertyDefinitionsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.PropertyDefinitionsApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.PropertyDefinitionsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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