Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.IRelationshipsApiAsync:
Public Member Functions | |
| System.Threading.Tasks.Task< CompleteRelationship > | CreateRelationshipAsync (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
| CreateRelationship: Create Relationship More... | |
| System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CompleteRelationship > > | CreateRelationshipWithHttpInfoAsync (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
| CreateRelationship: Create Relationship More... | |
| System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteRelationshipAsync (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
| [EARLY ACCESS] DeleteRelationship: Delete Relationship More... | |
| System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > | DeleteRelationshipWithHttpInfoAsync (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
| [EARLY ACCESS] DeleteRelationship: Delete Relationship 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), |
||
| ConfigurationOptions? | opts = null |
||
| ) |
CreateRelationship: Create Relationship
Create a relationship 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 relationship code The code of the relationship createRelationshipRequest The details of the relationship to create. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request. opts Options for this request.
- Returns
- Task of CompleteRelationship
Implemented in Lusid.Sdk.Api.RelationshipsApi.
◆ CreateRelationshipWithHttpInfoAsync()
| System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CompleteRelationship> > Lusid.Sdk.Api.IRelationshipsApiAsync.CreateRelationshipWithHttpInfoAsync | ( | string | scope, |
| string | code, | ||
| CreateRelationshipRequest | createRelationshipRequest, | ||
| int | operationIndex = 0, |
||
| System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken), |
||
| ConfigurationOptions? | opts = null |
||
| ) |
CreateRelationship: Create Relationship
Create a relationship 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 relationship code The code of the relationship createRelationshipRequest The details of the relationship to create. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request. opts Options for this 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), |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] DeleteRelationship: Delete Relationship
Delete a relationship 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 relationship code The code of the relationship deleteRelationshipRequest The details of the relationship to delete. 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.RelationshipsApi.
◆ DeleteRelationshipWithHttpInfoAsync()
| System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IRelationshipsApiAsync.DeleteRelationshipWithHttpInfoAsync | ( | string | scope, |
| string | code, | ||
| DeleteRelationshipRequest | deleteRelationshipRequest, | ||
| int | operationIndex = 0, |
||
| System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken), |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] DeleteRelationship: Delete Relationship
Delete a relationship 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 relationship code The code of the relationship deleteRelationshipRequest The details of the relationship to delete. 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.RelationshipsApi.
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/RelationshipsApi.cs
