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

Inheritance diagram for Lusid.Sdk.Api.IRelationsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< CompleteRelation >	CreateRelationAsync (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateRelation: Create Relation More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CompleteRelation > >	CreateRelationWithHttpInfoAsync (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateRelation: Create Relation More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationAsync (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRelation: Delete a relation More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteRelationWithHttpInfoAsync (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRelation: Delete a relation More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateRelationAsync()

System.Threading.Tasks.Task<CompleteRelation> Lusid.Sdk.Api.IRelationsApiAsync.CreateRelationAsync	(	string	scope,
		string	code,
		CreateRelationRequest	createRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateRelation: Create Relation

Create a relation between two entity objects by their identifiers

Exceptions

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

Parameters

scope	The scope of the relation definition
code	The code of the relation definition
createRelationRequest	The details of the relation to create.
effectiveAt	The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CompleteRelation

Implemented in Lusid.Sdk.Api.RelationsApi.

◆ CreateRelationWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CompleteRelation> > Lusid.Sdk.Api.IRelationsApiAsync.CreateRelationWithHttpInfoAsync	(	string	scope,
		string	code,
		CreateRelationRequest	createRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateRelation: Create Relation

Create a relation between two entity objects by their identifiers

Exceptions

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

Parameters

scope	The scope of the relation definition
code	The code of the relation definition
createRelationRequest	The details of the relation to create.
effectiveAt	The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CompleteRelation)

Implemented in Lusid.Sdk.Api.RelationsApi.

◆ DeleteRelationAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IRelationsApiAsync.DeleteRelationAsync	(	string	scope,
		string	code,
		DeleteRelationRequest	deleteRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteRelation: Delete a relation

Delete a relation between two entity objects represented by their identifiers

Exceptions

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

Parameters

scope	The scope of the relation definition
code	The code of the relation definition
deleteRelationRequest	The details of the relation to delete.
effectiveAt	The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.RelationsApi.

◆ DeleteRelationWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IRelationsApiAsync.DeleteRelationWithHttpInfoAsync	(	string	scope,
		string	code,
		DeleteRelationRequest	deleteRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteRelation: Delete a relation

Delete a relation between two entity objects represented by their identifiers

Exceptions

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

Parameters

scope	The scope of the relation definition
code	The code of the relation definition
deleteRelationRequest	The details of the relation to delete.
effectiveAt	The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.RelationsApi.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateRelationAsync()

◆ CreateRelationWithHttpInfoAsync()

◆ DeleteRelationAsync()

◆ DeleteRelationWithHttpInfoAsync()