LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IRelationshipsApiAsync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IRelationshipsApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< CompleteRelationshipCreateRelationshipAsync (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateRelationship: Create Relationship More...
 
System.Threading.Tasks.Task< ApiResponse< CompleteRelationship > > CreateRelationshipWithHttpInfoAsync (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateRelationship: Create Relationship More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteRelationshipAsync (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteRelationship: Delete Relationship More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteRelationshipWithHttpInfoAsync (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteRelationship: Delete Relationship 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

◆ CreateRelationshipAsync()

System.Threading.Tasks.Task<CompleteRelationship> Lusid.Sdk.Api.IRelationshipsApiAsync.CreateRelationshipAsync ( string  scope,
string  code,
CreateRelationshipRequest  createRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CreateRelationship: Create Relationship

Create a relationship between two entity objects by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
createRelationshipRequestThe details of the relationship to create.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CompleteRelationship

Implemented in Lusid.Sdk.Api.RelationshipsApi.

◆ CreateRelationshipWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CompleteRelationship> > Lusid.Sdk.Api.IRelationshipsApiAsync.CreateRelationshipWithHttpInfoAsync ( string  scope,
string  code,
CreateRelationshipRequest  createRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CreateRelationship: Create Relationship

Create a relationship between two entity objects by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
createRelationshipRequestThe details of the relationship to create.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CompleteRelationship)

Implemented in Lusid.Sdk.Api.RelationshipsApi.

◆ DeleteRelationshipAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IRelationshipsApiAsync.DeleteRelationshipAsync ( string  scope,
string  code,
DeleteRelationshipRequest  deleteRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteRelationship: Delete Relationship

Delete a relationship between two entity objects represented by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
deleteRelationshipRequestThe details of the relationship to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.RelationshipsApi.

◆ DeleteRelationshipWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IRelationshipsApiAsync.DeleteRelationshipWithHttpInfoAsync ( string  scope,
string  code,
DeleteRelationshipRequest  deleteRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteRelationship: Delete Relationship

Delete a relationship between two entity objects represented by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
deleteRelationshipRequestThe details of the relationship to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.RelationshipsApi.


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