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

Inheritance diagram for Lusid.Sdk.Api.PropertyDefinitionsApi:

[legend]

Public Member Functions
	PropertyDefinitionsApi ()
	Initializes a new instance of the PropertyDefinitionsApi class. More...

	PropertyDefinitionsApi (String basePath)
	Initializes a new instance of the PropertyDefinitionsApi class. More...

	PropertyDefinitionsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the PropertyDefinitionsApi class using Configuration object More...

	PropertyDefinitionsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the PropertyDefinitionsApi class using a Configuration object and client instance. More...

String	GetBasePath ()
	Gets the base path of the API client. More...

PropertyDefinition	CreateDerivedPropertyDefinition (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest)
	[EARLY ACCESS] Create derived property definition Define a new derived property. More...

Lusid.Sdk.Client.ApiResponse< PropertyDefinition >	CreateDerivedPropertyDefinitionWithHttpInfo (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest)
	[EARLY ACCESS] Create derived property definition Define a new derived property. More...

async System.Threading.Tasks.Task< PropertyDefinition >	CreateDerivedPropertyDefinitionAsync (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create derived property definition Define a new derived property. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PropertyDefinition > >	CreateDerivedPropertyDefinitionWithHttpInfoAsync (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create derived property definition Define a new derived property. More...

PropertyDefinition	CreatePropertyDefinition (CreatePropertyDefinitionRequest createPropertyDefinitionRequest)
	Create property definition Define a new property. More...

Lusid.Sdk.Client.ApiResponse< PropertyDefinition >	CreatePropertyDefinitionWithHttpInfo (CreatePropertyDefinitionRequest createPropertyDefinitionRequest)
	Create property definition Define a new property. More...

async System.Threading.Tasks.Task< PropertyDefinition >	CreatePropertyDefinitionAsync (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Create property definition Define a new property. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PropertyDefinition > >	CreatePropertyDefinitionWithHttpInfoAsync (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Create property definition Define a new property. More...

DeletedEntityResponse	DeletePropertyDefinition (string domain, string scope, string code)
	Delete property definition Delete the definition of the specified property. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeletePropertyDefinitionWithHttpInfo (string domain, string scope, string code)
	Delete property definition Delete the definition of the specified property. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePropertyDefinitionAsync (string domain, string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Delete property definition Delete the definition of the specified property. More...

ResourceListOfPropertyDefinition	GetMultiplePropertyDefinitions (List< string > propertyKeys, DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string))
	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))
	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), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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?))
	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?))
	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?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get property definition Retrieve the definition of a specified property. More...

PropertyDefinition	UpdatePropertyDefinition (string domain, string scope, string code, UpdatePropertyDefinitionRequest updatePropertyDefinitionRequest)
	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)
	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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ PropertyDefinitionsApi() [1/4]

Lusid.Sdk.Api.PropertyDefinitionsApi.PropertyDefinitionsApi ( )

inline

Initializes a new instance of the PropertyDefinitionsApi class.

Returns

◆ PropertyDefinitionsApi() [2/4]

Lusid.Sdk.Api.PropertyDefinitionsApi.PropertyDefinitionsApi ( String basePath )

inline

Initializes a new instance of the PropertyDefinitionsApi class.

Returns

◆ PropertyDefinitionsApi() [3/4]

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

inline

Initializes a new instance of the PropertyDefinitionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ PropertyDefinitionsApi() [4/4]

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

inline

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

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ CreateDerivedPropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.CreateDerivedPropertyDefinition ( CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest )

inline

[EARLY ACCESS] 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.

Returns: PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreateDerivedPropertyDefinitionAsync()

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

inline

[EARLY ACCESS] 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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ CreateDerivedPropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.CreateDerivedPropertyDefinitionWithHttpInfo ( CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest )

inline

[EARLY ACCESS] 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.

Returns: ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreateDerivedPropertyDefinitionWithHttpInfoAsync()

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

inline

[EARLY ACCESS] 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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PropertyDefinition)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ CreatePropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.CreatePropertyDefinition ( CreatePropertyDefinitionRequest createPropertyDefinitionRequest )

inline

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.

Returns: PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreatePropertyDefinitionAsync()

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

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ CreatePropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.CreatePropertyDefinitionWithHttpInfo ( CreatePropertyDefinitionRequest createPropertyDefinitionRequest )

inline

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.

Returns: ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ CreatePropertyDefinitionWithHttpInfoAsync()

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

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PropertyDefinition)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ DeletePropertyDefinition()

DeletedEntityResponse Lusid.Sdk.Api.PropertyDefinitionsApi.DeletePropertyDefinition	(	string	domain,
		string	scope,
		string	code
	)

inline

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.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ DeletePropertyDefinitionAsync()

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

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ DeletePropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PropertyDefinitionsApi.DeletePropertyDefinitionWithHttpInfo	(	string	domain,
		string	scope,
		string	code
	)

inline

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.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ DeletePropertyDefinitionWithHttpInfoAsync()

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

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetBasePath()

String Lusid.Sdk.Api.PropertyDefinitionsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetMultiplePropertyDefinitions()

ResourceListOfPropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.GetMultiplePropertyDefinitions	(	List< string >	propertyKeys,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`
	)

inline

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)

Returns: ResourceListOfPropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetMultiplePropertyDefinitionsAsync()

async System.Threading.Tasks.Task<ResourceListOfPropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.GetMultiplePropertyDefinitionsAsync	(	List< string >	propertyKeys,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetMultiplePropertyDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.GetMultiplePropertyDefinitionsWithHttpInfo	(	List< string >	propertyKeys,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`
	)

inline

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)

Returns: ApiResponse of ResourceListOfPropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetMultiplePropertyDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyDefinition> > Lusid.Sdk.Api.PropertyDefinitionsApi.GetMultiplePropertyDefinitionsWithHttpInfoAsync	(	List< string >	propertyKeys,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPropertyDefinition)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetPropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinition	(	string	domain,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

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)

Returns: PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetPropertyDefinitionAsync()

async System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinitionAsync	(	string	domain,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ GetPropertyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertyDefinition> Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinitionWithHttpInfo	(	string	domain,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

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)

Returns: ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ GetPropertyDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.PropertyDefinitionsApi.GetPropertyDefinitionWithHttpInfoAsync	(	string	domain,
		string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PropertyDefinition)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpdatePropertyDefinition()

PropertyDefinition Lusid.Sdk.Api.PropertyDefinitionsApi.UpdatePropertyDefinition	(	string	domain,
		string	scope,
		string	code,
		UpdatePropertyDefinitionRequest	updatePropertyDefinitionRequest
	)

inline

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.

Returns: PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpdatePropertyDefinitionAsync()

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

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

◆ UpdatePropertyDefinitionWithHttpInfo()

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

inline

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.

Returns: ApiResponse of PropertyDefinition

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiSync.

◆ UpdatePropertyDefinitionWithHttpInfoAsync()

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

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PropertyDefinition)

Implements Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

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

getset

The client for accessing this underlying API asynchronously.

◆ Client

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

getset

The client for accessing this underlying API synchronously.

◆ Configuration

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

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

getset

Provides a factory method hook for the creation of exceptions.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PropertyDefinitionsApi() [1/4]

◆ PropertyDefinitionsApi() [2/4]

◆ PropertyDefinitionsApi() [3/4]

◆ PropertyDefinitionsApi() [4/4]

Member Function Documentation

◆ CreateDerivedPropertyDefinition()

◆ CreateDerivedPropertyDefinitionAsync()

◆ CreateDerivedPropertyDefinitionWithHttpInfo()

◆ CreateDerivedPropertyDefinitionWithHttpInfoAsync()

◆ CreatePropertyDefinition()

◆ CreatePropertyDefinitionAsync()

◆ CreatePropertyDefinitionWithHttpInfo()

◆ CreatePropertyDefinitionWithHttpInfoAsync()

◆ DeletePropertyDefinition()

◆ DeletePropertyDefinitionAsync()

◆ DeletePropertyDefinitionWithHttpInfo()

◆ DeletePropertyDefinitionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetMultiplePropertyDefinitions()

◆ GetMultiplePropertyDefinitionsAsync()

◆ GetMultiplePropertyDefinitionsWithHttpInfo()

◆ GetMultiplePropertyDefinitionsWithHttpInfoAsync()

◆ GetPropertyDefinition()

◆ GetPropertyDefinitionAsync()

◆ GetPropertyDefinitionWithHttpInfo()

◆ GetPropertyDefinitionWithHttpInfoAsync()

◆ UpdatePropertyDefinition()

◆ UpdatePropertyDefinitionAsync()

◆ UpdatePropertyDefinitionWithHttpInfo()

◆ UpdatePropertyDefinitionWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory