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

Inheritance diagram for Lusid.Sdk.Api.IPropertyDefinitionsApiSync:

[legend]

Public Member Functions
PropertyDefinition	CreateDerivedPropertyDefinition (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition More...

ApiResponse< PropertyDefinition >	CreateDerivedPropertyDefinitionWithHttpInfo (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition More...

PropertyDefinition	CreatePropertyDefinition (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreatePropertyDefinition: Create property definition More...

ApiResponse< PropertyDefinition >	CreatePropertyDefinitionWithHttpInfo (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreatePropertyDefinition: Create property definition More...

DeletedEntityResponse	DeletePropertyDefinition (string domain, string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	DeletePropertyDefinition: Delete property definition More...

ApiResponse< DeletedEntityResponse >	DeletePropertyDefinitionWithHttpInfo (string domain, string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	DeletePropertyDefinition: Delete property definition More...

DeletedEntityResponse	DeletePropertyDefinitionProperties (string domain, string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties More...

ApiResponse< DeletedEntityResponse >	DeletePropertyDefinitionPropertiesWithHttpInfo (string domain, string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[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, ConfigurationOptions? opts=null)
	GetMultiplePropertyDefinitions: Get multiple property definitions More...

ApiResponse< ResourceListOfPropertyDefinition >	GetMultiplePropertyDefinitionsWithHttpInfo (List< string > propertyKeys, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	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, ConfigurationOptions? opts=null)
	GetPropertyDefinition: Get property definition More...

ApiResponse< PropertyDefinition >	GetPropertyDefinitionWithHttpInfo (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	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, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series More...

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, ConfigurationOptions? opts=null)
	[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, ConfigurationOptions? opts=null)
	ListPropertyDefinitions: List property definitions More...

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, ConfigurationOptions? opts=null)
	ListPropertyDefinitions: List property definitions More...

PropertyDefinition	UpdateDerivedPropertyDefinition (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition More...

ApiResponse< PropertyDefinition >	UpdateDerivedPropertyDefinitionWithHttpInfo (string domain, string scope, string code, UpdateDerivedPropertyDefinitionRequest updateDerivedPropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition More...

PropertyDefinition	UpdatePropertyDefinition (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	UpdatePropertyDefinition: Update property definition More...

ApiResponse< PropertyDefinition >	UpdatePropertyDefinitionWithHttpInfo (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	UpdatePropertyDefinition: Update property definition More...

BatchUpsertPropertyDefinitionPropertiesResponse	UpsertPropertyDefinitionProperties (string domain, string scope, string code, Dictionary< string, Property > requestBody, string? successMode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpsertPropertyDefinitionProperties: Upsert properties to a property definition More...

ApiResponse< BatchUpsertPropertyDefinitionPropertiesResponse >	UpsertPropertyDefinitionPropertiesWithHttpInfo (string domain, string scope, string code, Dictionary< string, Property > requestBody, string? successMode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreateDerivedPropertyDefinitionWithHttpInfo()

ApiResponse<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.CreateDerivedPropertyDefinitionWithHttpInfo	(	CreateDerivedPropertyDefinitionRequest	createDerivedPropertyDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.IPropertyDefinitionsApiSync.CreatePropertyDefinition	(	CreatePropertyDefinitionRequest	createPropertyDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

Returns: PropertyDefinition

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinitionWithHttpInfo()

ApiResponse<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiSync.CreatePropertyDefinitionWithHttpInfo	(	CreatePropertyDefinitionRequest	createPropertyDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

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`,
		ConfigurationOptions?	opts = `null`
	)

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.
opts	Options for this request.

Returns: ApiResponse of BatchUpsertPropertyDefinitionPropertiesResponse

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/PropertyDefinitionsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateDerivedPropertyDefinition()

◆ CreateDerivedPropertyDefinitionWithHttpInfo()

◆ CreatePropertyDefinition()

◆ CreatePropertyDefinitionWithHttpInfo()

◆ DeletePropertyDefinition()

◆ DeletePropertyDefinitionProperties()

◆ DeletePropertyDefinitionPropertiesWithHttpInfo()

◆ DeletePropertyDefinitionWithHttpInfo()

◆ GetMultiplePropertyDefinitions()

◆ GetMultiplePropertyDefinitionsWithHttpInfo()

◆ GetPropertyDefinition()

◆ GetPropertyDefinitionPropertyTimeSeries()

◆ GetPropertyDefinitionPropertyTimeSeriesWithHttpInfo()

◆ GetPropertyDefinitionWithHttpInfo()

◆ ListPropertyDefinitions()

◆ ListPropertyDefinitionsWithHttpInfo()

◆ UpdateDerivedPropertyDefinition()

◆ UpdateDerivedPropertyDefinitionWithHttpInfo()

◆ UpdatePropertyDefinition()

◆ UpdatePropertyDefinitionWithHttpInfo()

◆ UpsertPropertyDefinitionProperties()

◆ UpsertPropertyDefinitionPropertiesWithHttpInfo()