Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.PropertyDefinitionsApi:
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< PropertyDefinition > | CreateDerivedPropertyDefinitionWithHttpInfo (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0) |
| [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition Define a new derived property. More... | |
| async System.Threading.Tasks.Task< PropertyDefinition > | 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. 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< PropertyDefinition > | CreatePropertyDefinitionWithHttpInfo (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0) |
| CreatePropertyDefinition: Create property definition Define a new property. More... | |
| async System.Threading.Tasks.Task< PropertyDefinition > | CreatePropertyDefinitionAsync (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< DeletedEntityResponse > | DeletePropertyDefinitionWithHttpInfo (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< DeletedEntityResponse > | 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. 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< DeletedEntityResponse > | DeletePropertyDefinitionPropertiesWithHttpInfo (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< DeletedEntityResponse > | 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. 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< ResourceListOfPropertyDefinition > | GetMultiplePropertyDefinitionsWithHttpInfo (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< ResourceListOfPropertyDefinition > | 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. 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< PropertyDefinition > | GetPropertyDefinitionWithHttpInfo (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< PropertyDefinition > | 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. 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< ResourceListOfPropertyInterval > | 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) |
| [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< ResourceListOfPropertyInterval > | 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. 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< PagedResourceListOfPropertyDefinition > | 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) |
| ListPropertyDefinitions: List property definitions List all the property definitions matching particular criteria. More... | |
| async System.Threading.Tasks.Task< PagedResourceListOfPropertyDefinition > | 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. 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< PropertyDefinition > | UpdateDerivedPropertyDefinitionWithHttpInfo (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< PropertyDefinition > | 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 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< PropertyDefinition > | UpdatePropertyDefinitionWithHttpInfo (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< PropertyDefinition > | 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. 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) |
| [EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition More... | |
| Lusid.Sdk.Client.ApiResponse< BatchUpsertPropertyDefinitionPropertiesResponse > | UpsertPropertyDefinitionPropertiesWithHttpInfo (string domain, string scope, string code, Dictionary< string, Property > requestBody, string? successMode=default(string?), int operationIndex=0) |
| [EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition More... | |
| async System.Threading.Tasks.Task< BatchUpsertPropertyDefinitionPropertiesResponse > | 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)) |
| [EARLY ACCESS] 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)) |
| [EARLY ACCESS] 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]
|
inline |
Initializes a new instance of the PropertyDefinitionsApi class.
- Returns
◆ PropertyDefinitionsApi() [2/4]
|
inline |
Initializes a new instance of the PropertyDefinitionsApi class.
- Returns
◆ PropertyDefinitionsApi() [3/4]
|
inline |
Initializes a new instance of the PropertyDefinitionsApi class using Configuration object
- Parameters
-
configuration An instance of Configuration
- Returns
◆ PropertyDefinitionsApi() [4/4]
|
inline |
Initializes a new instance of the PropertyDefinitionsApi class using a Configuration object and client instance.
- Parameters
-
client The client interface for synchronous API access. asyncClient The client interface for asynchronous API access. configuration The configuration object.
Member Function Documentation
◆ CreateDerivedPropertyDefinition()
|
inline |
[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition Define a new derived property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createDerivedPropertyDefinitionRequest The definition of the new derived property. operationIndex Index associated with the operation.
- Returns
- PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ CreateDerivedPropertyDefinitionAsync()
|
inline |
[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition Define a new derived property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createDerivedPropertyDefinitionRequest The definition of the new derived property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ CreateDerivedPropertyDefinitionWithHttpInfo()
|
inline |
[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition Define a new derived property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createDerivedPropertyDefinitionRequest The definition of the new derived property. operationIndex Index associated with the operation.
- Returns
- ApiResponse of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ CreateDerivedPropertyDefinitionWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition Define a new derived property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createDerivedPropertyDefinitionRequest The definition of the new derived property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PropertyDefinition)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ CreatePropertyDefinition()
|
inline |
CreatePropertyDefinition: Create property definition Define a new property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createPropertyDefinitionRequest The definition of the new property. operationIndex Index associated with the operation.
- Returns
- PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ CreatePropertyDefinitionAsync()
|
inline |
CreatePropertyDefinition: Create property definition Define a new property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createPropertyDefinitionRequest The definition of the new property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ CreatePropertyDefinitionWithHttpInfo()
|
inline |
CreatePropertyDefinition: Create property definition Define a new property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createPropertyDefinitionRequest The definition of the new property. operationIndex Index associated with the operation.
- Returns
- ApiResponse of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ CreatePropertyDefinitionWithHttpInfoAsync()
|
inline |
CreatePropertyDefinition: Create property definition Define a new property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createPropertyDefinitionRequest The definition of the new property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PropertyDefinition)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ DeletePropertyDefinition()
|
inline |
DeletePropertyDefinition: Delete property definition Delete the definition of the specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property to be deleted. scope The scope of the property to be deleted. code The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. operationIndex Index associated with the operation.
- Returns
- DeletedEntityResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ DeletePropertyDefinitionAsync()
|
inline |
DeletePropertyDefinition: Delete property definition Delete the definition of the specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property to be deleted. scope The scope of the property to be deleted. code The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ DeletePropertyDefinitionProperties()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to delete properties from. scope The scope of the property definition to delete properties from. code The code of the property definition to delete properties from. requestBody The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' 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) operationIndex Index associated with the operation.
- Returns
- DeletedEntityResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ DeletePropertyDefinitionPropertiesAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to delete properties from. scope The scope of the property definition to delete properties from. code The code of the property definition to delete properties from. requestBody The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' 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) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ DeletePropertyDefinitionPropertiesWithHttpInfo()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to delete properties from. scope The scope of the property definition to delete properties from. code The code of the property definition to delete properties from. requestBody The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' 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) operationIndex Index associated with the operation.
- Returns
- ApiResponse of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ DeletePropertyDefinitionPropertiesWithHttpInfoAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to delete properties from. scope The scope of the property definition to delete properties from. code The code of the property definition to delete properties from. requestBody The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' 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) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (DeletedEntityResponse)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ DeletePropertyDefinitionWithHttpInfo()
|
inline |
DeletePropertyDefinition: Delete property definition Delete the definition of the specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property to be deleted. scope The scope of the property to be deleted. code The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. operationIndex Index associated with the operation.
- Returns
- ApiResponse of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ DeletePropertyDefinitionWithHttpInfoAsync()
|
inline |
DeletePropertyDefinition: Delete property definition Delete the definition of the specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property to be deleted. scope The scope of the property to be deleted. code The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (DeletedEntityResponse)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ GetBasePath()
|
inline |
◆ GetMultiplePropertyDefinitions()
|
inline |
GetMultiplePropertyDefinitions: Get multiple property definitions Retrieve the definition of one or more specified properties.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
propertyKeys One 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. 'Portfolio/Manager/Id'. asAt The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Lifetime, use "lifeTime eq 'Perpetual'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) effectiveAt The 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) operationIndex Index associated with the operation.
- Returns
- ResourceListOfPropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ GetMultiplePropertyDefinitionsAsync()
|
inline |
GetMultiplePropertyDefinitions: Get multiple property definitions Retrieve the definition of one or more specified properties.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
propertyKeys One 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. 'Portfolio/Manager/Id'. asAt The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Lifetime, use "lifeTime eq 'Perpetual'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) effectiveAt The 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) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfPropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ GetMultiplePropertyDefinitionsWithHttpInfo()
|
inline |
GetMultiplePropertyDefinitions: Get multiple property definitions Retrieve the definition of one or more specified properties.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
propertyKeys One 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. 'Portfolio/Manager/Id'. asAt The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Lifetime, use "lifeTime eq 'Perpetual'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) effectiveAt The 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) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfPropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ GetMultiplePropertyDefinitionsWithHttpInfoAsync()
|
inline |
GetMultiplePropertyDefinitions: Get multiple property definitions Retrieve the definition of one or more specified properties.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
propertyKeys One 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. 'Portfolio/Manager/Id'. asAt The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Lifetime, use "lifeTime eq 'Perpetual'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) effectiveAt The 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) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfPropertyDefinition)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ GetPropertyDefinition()
|
inline |
GetPropertyDefinition: Get property definition Retrieve the definition of a specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely identifies the property. asAt The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified. (optional) effectiveAt The 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) operationIndex Index associated with the operation.
- Returns
- PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ GetPropertyDefinitionAsync()
|
inline |
GetPropertyDefinition: Get property definition Retrieve the definition of a specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely identifies the property. asAt The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified. (optional) effectiveAt The 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) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ GetPropertyDefinitionPropertyTimeSeries()
|
inline |
[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series List the complete time series of a property definition property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to which the property is attached scope The scope of the property definition to which the property is attached code The code of the property definition to which the property is attached propertyKey The property key of the property whose history to show. This must be from the "Property Definition" domain and in the format {domain}/{scope}/{code}, for example "PropertyDefinition/myScope/someAttributeKey". asAt The asAt datetime at which to show the history. Defaults to the current datetime if not specified. (optional) filter Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation.
- Returns
- ResourceListOfPropertyInterval
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ GetPropertyDefinitionPropertyTimeSeriesAsync()
|
inline |
[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series List the complete time series of a property definition property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to which the property is attached scope The scope of the property definition to which the property is attached code The code of the property definition to which the property is attached propertyKey The property key of the property whose history to show. This must be from the "Property Definition" domain and in the format {domain}/{scope}/{code}, for example "PropertyDefinition/myScope/someAttributeKey". asAt The asAt datetime at which to show the history. Defaults to the current datetime if not specified. (optional) filter Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfPropertyInterval
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ GetPropertyDefinitionPropertyTimeSeriesWithHttpInfo()
|
inline |
[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series List the complete time series of a property definition property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to which the property is attached scope The scope of the property definition to which the property is attached code The code of the property definition to which the property is attached propertyKey The property key of the property whose history to show. This must be from the "Property Definition" domain and in the format {domain}/{scope}/{code}, for example "PropertyDefinition/myScope/someAttributeKey". asAt The asAt datetime at which to show the history. Defaults to the current datetime if not specified. (optional) filter Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfPropertyInterval
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ GetPropertyDefinitionPropertyTimeSeriesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series List the complete time series of a property definition property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property definition to which the property is attached scope The scope of the property definition to which the property is attached code The code of the property definition to which the property is attached propertyKey The property key of the property whose history to show. This must be from the "Property Definition" domain and in the format {domain}/{scope}/{code}, for example "PropertyDefinition/myScope/someAttributeKey". asAt The asAt datetime at which to show the history. Defaults to the current datetime if not specified. (optional) filter Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfPropertyInterval)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ GetPropertyDefinitionWithHttpInfo()
|
inline |
GetPropertyDefinition: Get property definition Retrieve the definition of a specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely identifies the property. asAt The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified. (optional) effectiveAt The 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) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ GetPropertyDefinitionWithHttpInfoAsync()
|
inline |
GetPropertyDefinition: Get property definition Retrieve the definition of a specified property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely identifies the property. asAt The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified. (optional) effectiveAt The 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) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PropertyDefinition)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ ListPropertyDefinitions()
|
inline |
ListPropertyDefinitions: List property definitions List all the property definitions matching particular criteria.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
effectiveAt The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified. (optional) propertyKeys A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. (optional) page The 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) limit When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) filter Expression to filter the results. For example, to filter on the display name, specify "DisplayName eq 'DisplayName'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) operationIndex Index associated with the operation.
- Returns
- PagedResourceListOfPropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ ListPropertyDefinitionsAsync()
|
inline |
ListPropertyDefinitions: List property definitions List all the property definitions matching particular criteria.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
effectiveAt The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified. (optional) propertyKeys A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. (optional) page The 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) limit When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) filter Expression to filter the results. For example, to filter on the display name, specify "DisplayName eq 'DisplayName'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PagedResourceListOfPropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ ListPropertyDefinitionsWithHttpInfo()
|
inline |
ListPropertyDefinitions: List property definitions List all the property definitions matching particular criteria.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
effectiveAt The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified. (optional) propertyKeys A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. (optional) page The 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) limit When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) filter Expression to filter the results. For example, to filter on the display name, specify "DisplayName eq 'DisplayName'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PagedResourceListOfPropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ ListPropertyDefinitionsWithHttpInfoAsync()
|
inline |
ListPropertyDefinitions: List property definitions List all the property definitions matching particular criteria.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
effectiveAt The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified. (optional) propertyKeys A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g "PropertyDefinition/myScope/someAttributeKey". Each property must be from the "PropertyDefinition" domain. (optional) page The 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) limit When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) filter Expression to filter the results. For example, to filter on the display name, specify "DisplayName eq 'DisplayName'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PagedResourceListOfPropertyDefinition)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ UpdateDerivedPropertyDefinition()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain Domain of the property definition scope Scope of the property definition code Code of the property definition updateDerivedPropertyDefinitionRequest Information about the derived property definition being updated operationIndex Index associated with the operation.
- Returns
- PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ UpdateDerivedPropertyDefinitionAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain Domain of the property definition scope Scope of the property definition code Code of the property definition updateDerivedPropertyDefinitionRequest Information about the derived property definition being updated operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ UpdateDerivedPropertyDefinitionWithHttpInfo()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain Domain of the property definition scope Scope of the property definition code Code of the property definition updateDerivedPropertyDefinitionRequest Information about the derived property definition being updated operationIndex Index associated with the operation.
- Returns
- ApiResponse of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ UpdateDerivedPropertyDefinitionWithHttpInfoAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain Domain of the property definition scope Scope of the property definition code Code of the property definition updateDerivedPropertyDefinitionRequest Information about the derived property definition being updated operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PropertyDefinition)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ UpdatePropertyDefinition()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property being updated. scope The scope of the property being updated. code The code of the property being updated. Together with the domain and scope this uniquely identifies the property. updatePropertyDefinitionRequest The updated definition of the property. operationIndex Index associated with the operation.
- Returns
- PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ UpdatePropertyDefinitionAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property being updated. scope The scope of the property being updated. code The code of the property being updated. Together with the domain and scope this uniquely identifies the property. updatePropertyDefinitionRequest The updated definition of the property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ UpdatePropertyDefinitionWithHttpInfo()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property being updated. scope The scope of the property being updated. code The code of the property being updated. Together with the domain and scope this uniquely identifies the property. updatePropertyDefinitionRequest The updated definition of the property. operationIndex Index associated with the operation.
- Returns
- ApiResponse of PropertyDefinition
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ UpdatePropertyDefinitionWithHttpInfoAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the property being updated. scope The scope of the property being updated. code The code of the property being updated. Together with the domain and scope this uniquely identifies the property. updatePropertyDefinitionRequest The updated definition of the property. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PropertyDefinition)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ UpsertPropertyDefinitionProperties()
|
inline |
[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely requestBody The 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 'PropertyDefinition/Manager/Id'. successMode Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") operationIndex Index associated with the operation.
- Returns
- BatchUpsertPropertyDefinitionPropertiesResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ UpsertPropertyDefinitionPropertiesAsync()
|
inline |
[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely requestBody The 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 'PropertyDefinition/Manager/Id'. successMode Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of BatchUpsertPropertyDefinitionPropertiesResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
◆ UpsertPropertyDefinitionPropertiesWithHttpInfo()
|
inline |
[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely requestBody The 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 'PropertyDefinition/Manager/Id'. successMode Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") operationIndex Index associated with the operation.
- Returns
- ApiResponse of BatchUpsertPropertyDefinitionPropertiesResponse
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.
◆ UpsertPropertyDefinitionPropertiesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition Create or update properties for a particular property definition
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
domain The domain of the specified property. scope The scope of the specified property. code The code of the specified property. Together with the domain and scope this uniquely requestBody The 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 'PropertyDefinition/Manager/Id'. successMode Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (BatchUpsertPropertyDefinitionPropertiesResponse)
Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.
Property Documentation
◆ AsynchronousClient
|
getset |
The client for accessing this underlying API asynchronously.
◆ Client
|
getset |
The client for accessing this underlying API synchronously.
◆ Configuration
|
getset |
Gets or sets the configuration object
An instance of the Configuration
◆ ExceptionFactory
|
getset |
Provides a factory method hook for the creation of exceptions.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/PropertyDefinitionsApi.cs
