Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.IRelationsApiSync:
Public Member Functions | |
| CompleteRelation | CreateRelation (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EXPERIMENTAL] CreateRelation: Create Relation More... | |
| ApiResponse< CompleteRelation > | CreateRelationWithHttpInfo (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EXPERIMENTAL] CreateRelation: Create Relation More... | |
| DeletedEntityResponse | DeleteRelation (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EXPERIMENTAL] DeleteRelation: Delete a relation More... | |
| ApiResponse< DeletedEntityResponse > | DeleteRelationWithHttpInfo (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EXPERIMENTAL] DeleteRelation: Delete a relation 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
◆ CreateRelation()
| CompleteRelation Lusid.Sdk.Api.IRelationsApiSync.CreateRelation | ( | string | scope, |
| string | code, | ||
| CreateRelationRequest | createRelationRequest, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- CompleteRelation
Implemented in Lusid.Sdk.Api.RelationsApi.
◆ CreateRelationWithHttpInfo()
| ApiResponse<CompleteRelation> Lusid.Sdk.Api.IRelationsApiSync.CreateRelationWithHttpInfo | ( | string | scope, |
| string | code, | ||
| CreateRelationRequest | createRelationRequest, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- ApiResponse of CompleteRelation
Implemented in Lusid.Sdk.Api.RelationsApi.
◆ DeleteRelation()
| DeletedEntityResponse Lusid.Sdk.Api.IRelationsApiSync.DeleteRelation | ( | string | scope, |
| string | code, | ||
| DeleteRelationRequest | deleteRelationRequest, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- DeletedEntityResponse
Implemented in Lusid.Sdk.Api.RelationsApi.
◆ DeleteRelationWithHttpInfo()
| ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IRelationsApiSync.DeleteRelationWithHttpInfo | ( | string | scope, |
| string | code, | ||
| DeleteRelationRequest | deleteRelationRequest, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- ApiResponse of 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
