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

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

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

Public Member Functions

PropertyDefinition CreateDerivedPropertyDefinition (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition More...
 
ApiResponse< PropertyDefinitionCreateDerivedPropertyDefinitionWithHttpInfo (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition More...
 
PropertyDefinition CreatePropertyDefinition (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0)
 CreatePropertyDefinition: Create property definition More...
 
ApiResponse< PropertyDefinitionCreatePropertyDefinitionWithHttpInfo (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0)
 CreatePropertyDefinition: Create property definition More...
 
DeletedEntityResponse DeletePropertyDefinition (string domain, string scope, string code, int operationIndex=0)
 DeletePropertyDefinition: Delete property definition More...
 
ApiResponse< DeletedEntityResponseDeletePropertyDefinitionWithHttpInfo (string domain, string scope, string code, int operationIndex=0)
 DeletePropertyDefinition: Delete property definition 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 More...
 
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 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 More...
 
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 More...
 
PropertyDefinition GetPropertyDefinition (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 GetPropertyDefinition: Get property definition More...
 
ApiResponse< PropertyDefinitionGetPropertyDefinitionWithHttpInfo (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 GetPropertyDefinition: Get property definition 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 More...
 
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 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 More...
 
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 More...
 
PropertyDefinition UpdateDerivedPropertyDefinition (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition More...
 
ApiResponse< PropertyDefinitionUpdateDerivedPropertyDefinitionWithHttpInfo (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition More...
 
PropertyDefinition UpdatePropertyDefinition (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0)
 UpdatePropertyDefinition: Update property definition More...
 
ApiResponse< PropertyDefinitionUpdatePropertyDefinitionWithHttpInfo (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0)
 UpdatePropertyDefinition: Update property definition 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 More...
 
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 More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

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

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateDerivedPropertyDefinition()

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

[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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreateDerivedPropertyDefinitionWithHttpInfo()

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

[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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinition()

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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinitionWithHttpInfo()

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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinition()

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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionProperties()

DeletedEntityResponse Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionPropertiesWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionWithHttpInfo()

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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetMultiplePropertyDefinitions()

ResourceListOfPropertyDefinition Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetMultiplePropertyDefinitionsWithHttpInfo()

ApiResponse<ResourceListOfPropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionPropertyTimeSeriesWithHttpInfo()

ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionWithHttpInfo()

ApiResponse<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ ListPropertyDefinitions()

PagedResourceListOfPropertyDefinition Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ ListPropertyDefinitionsWithHttpInfo()

ApiResponse<PagedResourceListOfPropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdateDerivedPropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdateDerivedPropertyDefinitionWithHttpInfo()

ApiResponse<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdatePropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdatePropertyDefinitionWithHttpInfo()

ApiResponse<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpsertPropertyDefinitionProperties()

BatchUpsertPropertyDefinitionPropertiesResponse Lusid.Sdk.Api.IPropertyDefinitionsApiSync.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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpsertPropertyDefinitionPropertiesWithHttpInfo()

ApiResponse<BatchUpsertPropertyDefinitionPropertiesResponse> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.UpsertPropertyDefinitionPropertiesWithHttpInfo ( 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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.


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