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

Inheritance diagram for Lusid.Sdk.Api.IRelationDefinitionsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< RelationDefinition >	CreateRelationDefinitionAsync (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition More...

System.Threading.Tasks.Task< ApiResponse< RelationDefinition > >	CreateRelationDefinitionWithHttpInfoAsync (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationDefinitionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteRelationDefinitionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition More...

System.Threading.Tasks.Task< RelationDefinition >	GetRelationDefinitionAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRelationDefinition: Get relation definition More...

System.Threading.Tasks.Task< ApiResponse< RelationDefinition > >	GetRelationDefinitionWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRelationDefinition: Get relation 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

◆ CreateRelationDefinitionAsync()

System.Threading.Tasks.Task<RelationDefinition> Lusid.Sdk.Api.IRelationDefinitionsApiAsync.CreateRelationDefinitionAsync	(	CreateRelationDefinitionRequest	createRelationDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition

Define a new relation.

Exceptions

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

Parameters

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

Returns: Task of RelationDefinition

Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.

◆ CreateRelationDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<RelationDefinition> > Lusid.Sdk.Api.IRelationDefinitionsApiAsync.CreateRelationDefinitionWithHttpInfoAsync	(	CreateRelationDefinitionRequest	createRelationDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition

Define a new relation.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (RelationDefinition)

Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.

◆ DeleteRelationDefinitionAsync()

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

[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition

Delete the definition of the specified relation.

Exceptions

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

Parameters

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

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.

◆ DeleteRelationDefinitionWithHttpInfoAsync()

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

[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition

Delete the definition of the specified relation.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.

◆ GetRelationDefinitionAsync()

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

[EXPERIMENTAL] GetRelationDefinition: Get relation definition

Retrieve the definition of a specified relation.

Exceptions

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

Parameters

scope	The scope of the specified relation.
code	The code of the specified relation. Together with the domain and scope this uniquely identifies the relation.
asAt	The asAt datetime at which to retrieve the relation 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 RelationDefinition

Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.

◆ GetRelationDefinitionWithHttpInfoAsync()

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

[EXPERIMENTAL] GetRelationDefinition: Get relation definition

Retrieve the definition of a specified relation.

Exceptions

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

Parameters

scope	The scope of the specified relation.
code	The code of the specified relation. Together with the domain and scope this uniquely identifies the relation.
asAt	The asAt datetime at which to retrieve the relation 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 (RelationDefinition)

Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateRelationDefinitionAsync()

◆ CreateRelationDefinitionWithHttpInfoAsync()

◆ DeleteRelationDefinitionAsync()

◆ DeleteRelationDefinitionWithHttpInfoAsync()

◆ GetRelationDefinitionAsync()

◆ GetRelationDefinitionWithHttpInfoAsync()