Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.IRelationshipsApiSync:
Public Member Functions | |
| CompleteRelationship | CreateRelationship (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
| CreateRelationship: Create Relationship More... | |
| Lusid.Sdk.Client.ApiResponse< CompleteRelationship > | CreateRelationshipWithHttpInfo (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
| CreateRelationship: Create Relationship More... | |
| DeletedEntityResponse | DeleteRelationship (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EARLY ACCESS] DeleteRelationship: Delete Relationship More... | |
| Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteRelationshipWithHttpInfo (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, 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
◆ CreateRelationship()
| CompleteRelationship Lusid.Sdk.Api.IRelationshipsApiSync.CreateRelationship | ( | string | scope, |
| string | code, | ||
| CreateRelationshipRequest | createRelationshipRequest, | ||
| int | operationIndex = 0, |
||
| 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. opts Options for this request.
- Returns
- CompleteRelationship
Implemented in Lusid.Sdk.Api.RelationshipsApi.
◆ CreateRelationshipWithHttpInfo()
| Lusid.Sdk.Client.ApiResponse<CompleteRelationship> Lusid.Sdk.Api.IRelationshipsApiSync.CreateRelationshipWithHttpInfo | ( | string | scope, |
| string | code, | ||
| CreateRelationshipRequest | createRelationshipRequest, | ||
| int | operationIndex = 0, |
||
| 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. opts Options for this request.
- Returns
- ApiResponse of CompleteRelationship
Implemented in Lusid.Sdk.Api.RelationshipsApi.
◆ DeleteRelationship()
| DeletedEntityResponse Lusid.Sdk.Api.IRelationshipsApiSync.DeleteRelationship | ( | string | scope, |
| string | code, | ||
| DeleteRelationshipRequest | deleteRelationshipRequest, | ||
| int | operationIndex = 0, |
||
| 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. opts Options for this request.
- Returns
- DeletedEntityResponse
Implemented in Lusid.Sdk.Api.RelationshipsApi.
◆ DeleteRelationshipWithHttpInfo()
| Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IRelationshipsApiSync.DeleteRelationshipWithHttpInfo | ( | string | scope, |
| string | code, | ||
| DeleteRelationshipRequest | deleteRelationshipRequest, | ||
| int | operationIndex = 0, |
||
| 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. opts Options for this request.
- Returns
- ApiResponse of 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
