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

Inheritance diagram for Lusid.Sdk.Api.RelationshipDefinitionsApi:

[legend]

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

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

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

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

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

RelationshipDefinition	CreateRelationshipDefinition (CreateRelationshipDefinitionRequest createRelationshipDefinitionRequest, int operationIndex=0)
	[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities. More...

Lusid.Sdk.Client.ApiResponse< RelationshipDefinition >	CreateRelationshipDefinitionWithHttpInfo (CreateRelationshipDefinitionRequest createRelationshipDefinitionRequest, int operationIndex=0)
	[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities. More...

async System.Threading.Tasks.Task< RelationshipDefinition >	CreateRelationshipDefinitionAsync (CreateRelationshipDefinitionRequest createRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationshipDefinition > >	CreateRelationshipDefinitionWithHttpInfoAsync (CreateRelationshipDefinitionRequest createRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities. More...

DeletedEntityResponse	DeleteRelationshipDefinition (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteRelationshipDefinitionWithHttpInfo (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationshipDefinitionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteRelationshipDefinitionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship. More...

RelationshipDefinition	GetRelationshipDefinition (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition More...

Lusid.Sdk.Client.ApiResponse< RelationshipDefinition >	GetRelationshipDefinitionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition More...

async System.Threading.Tasks.Task< RelationshipDefinition >	GetRelationshipDefinitionAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationshipDefinition > >	GetRelationshipDefinitionWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition More...

PagedResourceListOfRelationshipDefinition	ListRelationshipDefinitions (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfRelationshipDefinition >	ListRelationshipDefinitionsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions. More...

async System.Threading.Tasks.Task< PagedResourceListOfRelationshipDefinition >	ListRelationshipDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfRelationshipDefinition > >	ListRelationshipDefinitionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions. More...

RelationshipDefinition	UpdateRelationshipDefinition (string scope, string code, UpdateRelationshipDefinitionRequest updateRelationshipDefinitionRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. More...

Lusid.Sdk.Client.ApiResponse< RelationshipDefinition >	UpdateRelationshipDefinitionWithHttpInfo (string scope, string code, UpdateRelationshipDefinitionRequest updateRelationshipDefinitionRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. More...

async System.Threading.Tasks.Task< RelationshipDefinition >	UpdateRelationshipDefinitionAsync (string scope, string code, UpdateRelationshipDefinitionRequest updateRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationshipDefinition > >	UpdateRelationshipDefinitionWithHttpInfoAsync (string scope, string code, UpdateRelationshipDefinitionRequest updateRelationshipDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. 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

◆ RelationshipDefinitionsApi() [1/4]

Lusid.Sdk.Api.RelationshipDefinitionsApi.RelationshipDefinitionsApi ( )

inline

Initializes a new instance of the RelationshipDefinitionsApi class.

Returns

◆ RelationshipDefinitionsApi() [2/4]

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

inline

Initializes a new instance of the RelationshipDefinitionsApi class.

Returns

◆ RelationshipDefinitionsApi() [3/4]

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

inline

Initializes a new instance of the RelationshipDefinitionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ RelationshipDefinitionsApi() [4/4]

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

inline

Initializes a new instance of the RelationshipDefinitionsApi 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

◆ CreateRelationshipDefinition()

RelationshipDefinition Lusid.Sdk.Api.RelationshipDefinitionsApi.CreateRelationshipDefinition	(	CreateRelationshipDefinitionRequest	createRelationshipDefinitionRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createRelationshipDefinitionRequest	The definition of the new relationship.
operationIndex	Index associated with the operation.

Returns: RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ CreateRelationshipDefinitionAsync()

async System.Threading.Tasks.Task<RelationshipDefinition> Lusid.Sdk.Api.RelationshipDefinitionsApi.CreateRelationshipDefinitionAsync	(	CreateRelationshipDefinitionRequest	createRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createRelationshipDefinitionRequest	The definition of the new relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ CreateRelationshipDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationshipDefinition> Lusid.Sdk.Api.RelationshipDefinitionsApi.CreateRelationshipDefinitionWithHttpInfo	(	CreateRelationshipDefinitionRequest	createRelationshipDefinitionRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createRelationshipDefinitionRequest	The definition of the new relationship.
operationIndex	Index associated with the operation.

Returns: ApiResponse of RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ CreateRelationshipDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationshipDefinition> > Lusid.Sdk.Api.RelationshipDefinitionsApi.CreateRelationshipDefinitionWithHttpInfoAsync	(	CreateRelationshipDefinitionRequest	createRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition Create a new relationship definition to be used for creating relationships between entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createRelationshipDefinitionRequest	The definition of the new relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (RelationshipDefinition)

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ DeleteRelationshipDefinition()

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

inline

[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition to be deleted.
code	The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ DeleteRelationshipDefinitionAsync()

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

inline

[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition to be deleted.
code	The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ DeleteRelationshipDefinitionWithHttpInfo()

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

inline

[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition to be deleted.
code	The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ DeleteRelationshipDefinitionWithHttpInfoAsync()

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

inline

[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition Delete the definition of the specified relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition to be deleted.
code	The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetRelationshipDefinition()

RelationshipDefinition Lusid.Sdk.Api.RelationshipDefinitionsApi.GetRelationshipDefinition	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified relationship definition.
code	The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
asAt	The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ GetRelationshipDefinitionAsync()

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

inline

[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified relationship definition.
code	The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
asAt	The asAt datetime at which to retrieve the relationship 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 RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ GetRelationshipDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationshipDefinition> Lusid.Sdk.Api.RelationshipDefinitionsApi.GetRelationshipDefinitionWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified relationship definition.
code	The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
asAt	The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ GetRelationshipDefinitionWithHttpInfoAsync()

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

inline

[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition Retrieve the specified relationship definition

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the specified relationship definition.
code	The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
asAt	The asAt datetime at which to retrieve the relationship 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 (RelationshipDefinition)

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ ListRelationshipDefinitions()

PagedResourceListOfRelationshipDefinition Lusid.Sdk.Api.RelationshipDefinitionsApi.ListRelationshipDefinitions	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified. (optional)
page	The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'ExampleScope'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfRelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ ListRelationshipDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfRelationshipDefinition> Lusid.Sdk.Api.RelationshipDefinitionsApi.ListRelationshipDefinitionsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified. (optional)
page	The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'ExampleScope'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfRelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ ListRelationshipDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationshipDefinition> Lusid.Sdk.Api.RelationshipDefinitionsApi.ListRelationshipDefinitionsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified. (optional)
page	The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'ExampleScope'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfRelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ ListRelationshipDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationshipDefinition> > Lusid.Sdk.Api.RelationshipDefinitionsApi.ListRelationshipDefinitionsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions Retrieve one or more specified relationship definitions.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified. (optional)
page	The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'ExampleScope'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfRelationshipDefinition)

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ UpdateRelationshipDefinition()

RelationshipDefinition Lusid.Sdk.Api.RelationshipDefinitionsApi.UpdateRelationshipDefinition	(	string	scope,
		string	code,
		UpdateRelationshipDefinitionRequest	updateRelationshipDefinitionRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition being updated.
code	The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
updateRelationshipDefinitionRequest	The details of relationship definition to update.
operationIndex	Index associated with the operation.

Returns: RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ UpdateRelationshipDefinitionAsync()

async System.Threading.Tasks.Task<RelationshipDefinition> Lusid.Sdk.Api.RelationshipDefinitionsApi.UpdateRelationshipDefinitionAsync	(	string	scope,
		string	code,
		UpdateRelationshipDefinitionRequest	updateRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition being updated.
code	The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
updateRelationshipDefinitionRequest	The details of relationship definition to update.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

◆ UpdateRelationshipDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationshipDefinition> Lusid.Sdk.Api.RelationshipDefinitionsApi.UpdateRelationshipDefinitionWithHttpInfo	(	string	scope,
		string	code,
		UpdateRelationshipDefinitionRequest	updateRelationshipDefinitionRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition being updated.
code	The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
updateRelationshipDefinitionRequest	The details of relationship definition to update.
operationIndex	Index associated with the operation.

Returns: ApiResponse of RelationshipDefinition

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiSync.

◆ UpdateRelationshipDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationshipDefinition> > Lusid.Sdk.Api.RelationshipDefinitionsApi.UpdateRelationshipDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateRelationshipDefinitionRequest	updateRelationshipDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the relationship definition being updated.
code	The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
updateRelationshipDefinitionRequest	The details of relationship definition to update.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (RelationshipDefinition)

Implements Lusid.Sdk.Api.IRelationshipDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.RelationshipDefinitionsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.RelationshipDefinitionsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.RelationshipDefinitionsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.RelationshipDefinitionsApi.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/RelationshipDefinitionsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RelationshipDefinitionsApi() [1/4]

◆ RelationshipDefinitionsApi() [2/4]

◆ RelationshipDefinitionsApi() [3/4]

◆ RelationshipDefinitionsApi() [4/4]

Member Function Documentation

◆ CreateRelationshipDefinition()

◆ CreateRelationshipDefinitionAsync()

◆ CreateRelationshipDefinitionWithHttpInfo()

◆ CreateRelationshipDefinitionWithHttpInfoAsync()

◆ DeleteRelationshipDefinition()

◆ DeleteRelationshipDefinitionAsync()

◆ DeleteRelationshipDefinitionWithHttpInfo()

◆ DeleteRelationshipDefinitionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetRelationshipDefinition()

◆ GetRelationshipDefinitionAsync()

◆ GetRelationshipDefinitionWithHttpInfo()

◆ GetRelationshipDefinitionWithHttpInfoAsync()

◆ ListRelationshipDefinitions()

◆ ListRelationshipDefinitionsAsync()

◆ ListRelationshipDefinitionsWithHttpInfo()

◆ ListRelationshipDefinitionsWithHttpInfoAsync()

◆ UpdateRelationshipDefinition()

◆ UpdateRelationshipDefinitionAsync()

◆ UpdateRelationshipDefinitionWithHttpInfo()

◆ UpdateRelationshipDefinitionWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory