Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.IRelationDefinitionsApiSync:
Public Member Functions | |
| RelationDefinition | CreateRelationDefinition (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0) |
| [EXPERIMENTAL] CreateRelationDefinition: Create a relation definition More... | |
| ApiResponse< RelationDefinition > | CreateRelationDefinitionWithHttpInfo (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0) |
| [EXPERIMENTAL] CreateRelationDefinition: Create a relation definition More... | |
| DeletedEntityResponse | DeleteRelationDefinition (string scope, string code, int operationIndex=0) |
| [EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition More... | |
| ApiResponse< DeletedEntityResponse > | DeleteRelationDefinitionWithHttpInfo (string scope, string code, int operationIndex=0) |
| [EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition More... | |
| RelationDefinition | GetRelationDefinition (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EXPERIMENTAL] GetRelationDefinition: Get relation definition More... | |
| ApiResponse< RelationDefinition > | GetRelationDefinitionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EXPERIMENTAL] GetRelationDefinition: Get relation definition 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
◆ CreateRelationDefinition()
| RelationDefinition Lusid.Sdk.Api.IRelationDefinitionsApiSync.CreateRelationDefinition | ( | CreateRelationDefinitionRequest | createRelationDefinitionRequest, |
| int | operationIndex = 0 |
||
| ) |
[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition
Define a new relation.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createRelationDefinitionRequest The definition of the new relation. operationIndex Index associated with the operation.
- Returns
- RelationDefinition
Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.
◆ CreateRelationDefinitionWithHttpInfo()
| ApiResponse<RelationDefinition> Lusid.Sdk.Api.IRelationDefinitionsApiSync.CreateRelationDefinitionWithHttpInfo | ( | CreateRelationDefinitionRequest | createRelationDefinitionRequest, |
| int | operationIndex = 0 |
||
| ) |
[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition
Define a new relation.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createRelationDefinitionRequest The definition of the new relation. operationIndex Index associated with the operation.
- Returns
- ApiResponse of RelationDefinition
Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.
◆ DeleteRelationDefinition()
| DeletedEntityResponse Lusid.Sdk.Api.IRelationDefinitionsApiSync.DeleteRelationDefinition | ( | string | scope, |
| string | code, | ||
| int | operationIndex = 0 |
||
| ) |
[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition
Delete the definition of the specified relation.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the relation to be deleted. code The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation. operationIndex Index associated with the operation.
- Returns
- DeletedEntityResponse
Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.
◆ DeleteRelationDefinitionWithHttpInfo()
| ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IRelationDefinitionsApiSync.DeleteRelationDefinitionWithHttpInfo | ( | string | scope, |
| string | code, | ||
| int | operationIndex = 0 |
||
| ) |
[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition
Delete the definition of the specified relation.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the relation to be deleted. code The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation. operationIndex Index associated with the operation.
- Returns
- ApiResponse of DeletedEntityResponse
Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.
◆ GetRelationDefinition()
| RelationDefinition Lusid.Sdk.Api.IRelationDefinitionsApiSync.GetRelationDefinition | ( | string | scope, |
| string | code, | ||
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| int | operationIndex = 0 |
||
| ) |
[EXPERIMENTAL] GetRelationDefinition: Get relation definition
Retrieve the definition of a specified relation.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the specified relation. code The code of the specified relation. Together with the domain and scope this uniquely identifies the relation. asAt The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified. (optional) operationIndex Index associated with the operation.
- Returns
- RelationDefinition
Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.
◆ GetRelationDefinitionWithHttpInfo()
| ApiResponse<RelationDefinition> Lusid.Sdk.Api.IRelationDefinitionsApiSync.GetRelationDefinitionWithHttpInfo | ( | string | scope, |
| string | code, | ||
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| int | operationIndex = 0 |
||
| ) |
[EXPERIMENTAL] GetRelationDefinition: Get relation definition
Retrieve the definition of a specified relation.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the specified relation. code The code of the specified relation. Together with the domain and scope this uniquely identifies the relation. asAt The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of RelationDefinition
Implemented in Lusid.Sdk.Api.RelationDefinitionsApi.
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/RelationDefinitionsApi.cs
