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

Inheritance diagram for Lusid.Sdk.Api.RelationDefinitionsApi:

[legend]

Public Member Functions
	RelationDefinitionsApi ()
	Initializes a new instance of the RelationDefinitionsApi class. More...

	RelationDefinitionsApi (string basePath)
	Initializes a new instance of the RelationDefinitionsApi class. More...

	RelationDefinitionsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the RelationDefinitionsApi class using Configuration object More...

	RelationDefinitionsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the RelationDefinitionsApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

RelationDefinition	CreateRelationDefinition (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition Define a new relation. More...

Lusid.Sdk.Client.ApiResponse< RelationDefinition >	CreateRelationDefinitionWithHttpInfo (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition Define a new relation. More...

async System.Threading.Tasks.Task< RelationDefinition >	CreateRelationDefinitionAsync (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition Define a new relation. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationDefinition > >	CreateRelationDefinitionWithHttpInfoAsync (CreateRelationDefinitionRequest createRelationDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition Define a new relation. More...

DeletedEntityResponse	DeleteRelationDefinition (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition Delete the definition of the specified relation. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteRelationDefinitionWithHttpInfo (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition Delete the definition of the specified relation. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationDefinitionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition Delete the definition of the specified relation. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteRelationDefinitionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition Delete the definition of the specified relation. More...

RelationDefinition	GetRelationDefinition (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetRelationDefinition: Get relation definition Retrieve the definition of a specified relation. More...

Lusid.Sdk.Client.ApiResponse< RelationDefinition >	GetRelationDefinitionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetRelationDefinition: Get relation definition Retrieve the definition of a specified relation. More...

async System.Threading.Tasks.Task< RelationDefinition >	GetRelationDefinitionAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRelationDefinition: Get relation definition Retrieve the definition of a specified relation. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationDefinition > >	GetRelationDefinitionWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRelationDefinition: Get relation definition Retrieve the definition of a specified relation. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

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

Constructor & Destructor Documentation

◆ RelationDefinitionsApi() [1/4]

Lusid.Sdk.Api.RelationDefinitionsApi.RelationDefinitionsApi ( )

inline

Initializes a new instance of the RelationDefinitionsApi class.

Returns

◆ RelationDefinitionsApi() [2/4]

Lusid.Sdk.Api.RelationDefinitionsApi.RelationDefinitionsApi ( string basePath )

inline

Initializes a new instance of the RelationDefinitionsApi class.

Returns

◆ RelationDefinitionsApi() [3/4]

Lusid.Sdk.Api.RelationDefinitionsApi.RelationDefinitionsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the RelationDefinitionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ RelationDefinitionsApi() [4/4]

Lusid.Sdk.Api.RelationDefinitionsApi.RelationDefinitionsApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the RelationDefinitionsApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ CreateRelationDefinition()

RelationDefinition Lusid.Sdk.Api.RelationDefinitionsApi.CreateRelationDefinition	(	CreateRelationDefinitionRequest	createRelationDefinitionRequest,
		int	operationIndex = `0`
	)

inline

[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

Implements Lusid.Sdk.Api.IRelationDefinitionsApiSync.

◆ CreateRelationDefinitionAsync()

async System.Threading.Tasks.Task<RelationDefinition> Lusid.Sdk.Api.RelationDefinitionsApi.CreateRelationDefinitionAsync	(	CreateRelationDefinitionRequest	createRelationDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of RelationDefinition

Implements Lusid.Sdk.Api.IRelationDefinitionsApiAsync.

◆ CreateRelationDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationDefinition> Lusid.Sdk.Api.RelationDefinitionsApi.CreateRelationDefinitionWithHttpInfo	(	CreateRelationDefinitionRequest	createRelationDefinitionRequest,
		int	operationIndex = `0`
	)

inline

[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

Implements Lusid.Sdk.Api.IRelationDefinitionsApiSync.

◆ CreateRelationDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationDefinition> > Lusid.Sdk.Api.RelationDefinitionsApi.CreateRelationDefinitionWithHttpInfoAsync	(	CreateRelationDefinitionRequest	createRelationDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (RelationDefinition)

Implements Lusid.Sdk.Api.IRelationDefinitionsApiAsync.

◆ DeleteRelationDefinition()

DeletedEntityResponse Lusid.Sdk.Api.RelationDefinitionsApi.DeleteRelationDefinition	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

inline

[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

Implements Lusid.Sdk.Api.IRelationDefinitionsApiSync.

◆ DeleteRelationDefinitionAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.RelationDefinitionsApi.DeleteRelationDefinitionAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationDefinitionsApiAsync.

◆ DeleteRelationDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.RelationDefinitionsApi.DeleteRelationDefinitionWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

inline

[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

Implements Lusid.Sdk.Api.IRelationDefinitionsApiSync.

◆ DeleteRelationDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.RelationDefinitionsApi.DeleteRelationDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IRelationDefinitionsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.RelationDefinitionsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetRelationDefinition()

RelationDefinition Lusid.Sdk.Api.RelationDefinitionsApi.GetRelationDefinition	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[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

Implements Lusid.Sdk.Api.IRelationDefinitionsApiSync.

◆ GetRelationDefinitionAsync()

async System.Threading.Tasks.Task<RelationDefinition> Lusid.Sdk.Api.RelationDefinitionsApi.GetRelationDefinitionAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of RelationDefinition

Implements Lusid.Sdk.Api.IRelationDefinitionsApiAsync.

◆ GetRelationDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationDefinition> Lusid.Sdk.Api.RelationDefinitionsApi.GetRelationDefinitionWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[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

Implements Lusid.Sdk.Api.IRelationDefinitionsApiSync.

◆ GetRelationDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationDefinition> > Lusid.Sdk.Api.RelationDefinitionsApi.GetRelationDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (RelationDefinition)

Implements Lusid.Sdk.Api.IRelationDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.RelationDefinitionsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.RelationDefinitionsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.RelationDefinitionsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.RelationDefinitionsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/RelationDefinitionsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RelationDefinitionsApi() [1/4]

◆ RelationDefinitionsApi() [2/4]

◆ RelationDefinitionsApi() [3/4]

◆ RelationDefinitionsApi() [4/4]

Member Function Documentation

◆ CreateRelationDefinition()

◆ CreateRelationDefinitionAsync()

◆ CreateRelationDefinitionWithHttpInfo()

◆ CreateRelationDefinitionWithHttpInfoAsync()

◆ DeleteRelationDefinition()

◆ DeleteRelationDefinitionAsync()

◆ DeleteRelationDefinitionWithHttpInfo()

◆ DeleteRelationDefinitionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetRelationDefinition()

◆ GetRelationDefinitionAsync()

◆ GetRelationDefinitionWithHttpInfo()

◆ GetRelationDefinitionWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory