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

Inheritance diagram for Lusid.Sdk.Api.IPropertyDefinitionsApiAsync:

Public Member Functions
System.Threading.Tasks.Task< PropertyDefinition >	CreateDerivedPropertyDefinitionAsync (CreateDerivedPropertyDefinitionRequest createDerivedPropertyDefinitionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create derived property definition More...

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

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

System.Threading.Tasks.Task< ApiResponse< PropertyDefinition > >	CreatePropertyDefinitionWithHttpInfoAsync (CreatePropertyDefinitionRequest createPropertyDefinitionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Create property definition More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePropertyDefinitionAsync (string domain, string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Delete property definition More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePropertyDefinitionWithHttpInfoAsync (string domain, string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Delete property definition More...

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 More...

System.Threading.Tasks.Task< 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 More...

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 More...

System.Threading.Tasks.Task< ApiResponse< PropertyDefinition > >	GetPropertyDefinitionWithHttpInfoAsync (string domain, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get property definition More...

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 More...

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

◆ CreateDerivedPropertyDefinitionAsync()

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

[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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreateDerivedPropertyDefinitionWithHttpInfoAsync()

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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinitionAsync()

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

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ CreatePropertyDefinitionWithHttpInfoAsync()

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

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)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ DeletePropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetMultiplePropertyDefinitionsAsync()

System.Threading.Tasks.Task<ResourceListOfPropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetMultiplePropertyDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionAsync()

System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ GetPropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdatePropertyDefinitionAsync()

System.Threading.Tasks.Task<PropertyDefinition> Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.PropertyDefinitionsApi.

◆ UpdatePropertyDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PropertyDefinition> > Lusid.Sdk.Api.IPropertyDefinitionsApiAsync.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.

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)

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/stable/sdk/Lusid.Sdk/Api/PropertyDefinitionsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateDerivedPropertyDefinitionAsync()

◆ CreateDerivedPropertyDefinitionWithHttpInfoAsync()

◆ CreatePropertyDefinitionAsync()

◆ CreatePropertyDefinitionWithHttpInfoAsync()

◆ DeletePropertyDefinitionAsync()

◆ DeletePropertyDefinitionWithHttpInfoAsync()

◆ GetMultiplePropertyDefinitionsAsync()

◆ GetMultiplePropertyDefinitionsWithHttpInfoAsync()

◆ GetPropertyDefinitionAsync()

◆ GetPropertyDefinitionWithHttpInfoAsync()

◆ UpdatePropertyDefinitionAsync()

◆ UpdatePropertyDefinitionWithHttpInfoAsync()