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

Inheritance diagram for Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< RelationshipDefinition >	CreateRelationshipDefinitionAsync (CreateRelationshipDefinitionRequest createRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition More...

System.Threading.Tasks.Task< ApiResponse< RelationshipDefinition > >	CreateRelationshipDefinitionWithHttpInfoAsync (CreateRelationshipDefinitionRequest createRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationshipDefinitionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteRelationshipDefinitionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition More...

System.Threading.Tasks.Task< RelationshipDefinition >	GetRelationshipDefinitionAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition More...

System.Threading.Tasks.Task< ApiResponse< RelationshipDefinition > >	GetRelationshipDefinitionWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition More...

System.Threading.Tasks.Task< PagedResourceListOfRelationshipDefinition >	ListRelationshipDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfRelationshipDefinition > >	ListRelationshipDefinitionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions More...

System.Threading.Tasks.Task< RelationshipDefinition >	UpdateRelationshipDefinitionAsync (string scope, string code, UpdateRelationshipDefinitionRequest updateRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition More...

System.Threading.Tasks.Task< ApiResponse< RelationshipDefinition > >	UpdateRelationshipDefinitionWithHttpInfoAsync (string scope, string code, UpdateRelationshipDefinitionRequest updateRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship 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

◆ CreateRelationshipDefinitionAsync()

System.Threading.Tasks.Task<RelationshipDefinition> Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.CreateRelationshipDefinitionAsync	(	CreateRelationshipDefinitionRequest	createRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition

Create a new relationship definition to be used for creating relationships between entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createRelationshipDefinitionRequest	The definition of the new relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of RelationshipDefinition

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ CreateRelationshipDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<RelationshipDefinition> > Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.CreateRelationshipDefinitionWithHttpInfoAsync	(	CreateRelationshipDefinitionRequest	createRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition

Create a new relationship definition to be used for creating relationships between entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createRelationshipDefinitionRequest	The definition of the new relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (RelationshipDefinition)

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ DeleteRelationshipDefinitionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.DeleteRelationshipDefinitionAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition

Delete the definition of the specified relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition to be deleted.
code	The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ DeleteRelationshipDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.DeleteRelationshipDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition

Delete the definition of the specified relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition to be deleted.
code	The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ GetRelationshipDefinitionAsync()

System.Threading.Tasks.Task<RelationshipDefinition> Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.GetRelationshipDefinitionAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition

Retrieve the specified relationship definition

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified relationship definition.
code	The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
asAt	The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of RelationshipDefinition

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ GetRelationshipDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<RelationshipDefinition> > Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.GetRelationshipDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition

Retrieve the specified relationship definition

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified relationship definition.
code	The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
asAt	The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (RelationshipDefinition)

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ ListRelationshipDefinitionsAsync()

System.Threading.Tasks.Task<PagedResourceListOfRelationshipDefinition> Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.ListRelationshipDefinitionsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions

Retrieve one or more specified relationship definitions.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified. (optional)
page	The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'ExampleScope'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfRelationshipDefinition

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ ListRelationshipDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfRelationshipDefinition> > Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.ListRelationshipDefinitionsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions

Retrieve one or more specified relationship definitions.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified. (optional)
page	The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'ExampleScope'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfRelationshipDefinition)

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ UpdateRelationshipDefinitionAsync()

System.Threading.Tasks.Task<RelationshipDefinition> Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.UpdateRelationshipDefinitionAsync	(	string	scope,
		string	code,
		UpdateRelationshipDefinitionRequest	updateRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition

Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition being updated.
code	The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
updateRelationshipDefinitionRequest	The details of relationship definition to update.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of RelationshipDefinition

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

◆ UpdateRelationshipDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<RelationshipDefinition> > Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.UpdateRelationshipDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateRelationshipDefinitionRequest	updateRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition

Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition being updated.
code	The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
updateRelationshipDefinitionRequest	The details of relationship definition to update.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (RelationshipDefinition)

Implemented in Lusid.Sdk.Api.RelationshipDefinitionsApi.

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/RelationshipDefinitionsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateRelationshipDefinitionAsync()

◆ CreateRelationshipDefinitionWithHttpInfoAsync()

◆ DeleteRelationshipDefinitionAsync()

◆ DeleteRelationshipDefinitionWithHttpInfoAsync()

◆ GetRelationshipDefinitionAsync()

◆ GetRelationshipDefinitionWithHttpInfoAsync()

◆ ListRelationshipDefinitionsAsync()

◆ ListRelationshipDefinitionsWithHttpInfoAsync()

◆ UpdateRelationshipDefinitionAsync()

◆ UpdateRelationshipDefinitionWithHttpInfoAsync()