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

Inheritance diagram for Lusid.Sdk.Api.IdentifierDefinitionsApi:

[legend]

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

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

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

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

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

IdentifierDefinition	CreateIdentifierDefinition (CreateIdentifierDefinitionRequest? createIdentifierDefinitionRequest=default(CreateIdentifierDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition More...

Lusid.Sdk.Client.ApiResponse< IdentifierDefinition >	CreateIdentifierDefinitionWithHttpInfo (CreateIdentifierDefinitionRequest? createIdentifierDefinitionRequest=default(CreateIdentifierDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition More...

async System.Threading.Tasks.Task< IdentifierDefinition >	CreateIdentifierDefinitionAsync (CreateIdentifierDefinitionRequest? createIdentifierDefinitionRequest=default(CreateIdentifierDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< IdentifierDefinition > >	CreateIdentifierDefinitionWithHttpInfoAsync (CreateIdentifierDefinitionRequest? createIdentifierDefinitionRequest=default(CreateIdentifierDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition More...

DeletedEntityResponse	DeleteIdentifierDefinition (string domain, string identifierScope, string identifierType, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteIdentifierDefinitionWithHttpInfo (string domain, string identifierScope, string identifierType, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteIdentifierDefinitionAsync (string domain, string identifierScope, string identifierType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteIdentifierDefinitionWithHttpInfoAsync (string domain, string identifierScope, string identifierType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. More...

IdentifierDefinition	GetIdentifierDefinition (string domain, string identifierScope, string identifierType, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified More...

Lusid.Sdk.Client.ApiResponse< IdentifierDefinition >	GetIdentifierDefinitionWithHttpInfo (string domain, string identifierScope, string identifierType, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified More...

async System.Threading.Tasks.Task< IdentifierDefinition >	GetIdentifierDefinitionAsync (string domain, string identifierScope, string identifierType, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< IdentifierDefinition > >	GetIdentifierDefinitionWithHttpInfoAsync (string domain, string identifierScope, string identifierType, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified More...

PagedResourceListOfIdentifierDefinition	ListIdentifierDefinitions (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfIdentifierDefinition >	ListIdentifierDefinitionsWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination More...

async System.Threading.Tasks.Task< PagedResourceListOfIdentifierDefinition >	ListIdentifierDefinitionsAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfIdentifierDefinition > >	ListIdentifierDefinitionsWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination More...

IdentifierDefinition	UpdateIdentifierDefinition (string domain, string identifierScope, string identifierType, UpdateIdentifierDefinitionRequest? updateIdentifierDefinitionRequest=default(UpdateIdentifierDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition. More...

Lusid.Sdk.Client.ApiResponse< IdentifierDefinition >	UpdateIdentifierDefinitionWithHttpInfo (string domain, string identifierScope, string identifierType, UpdateIdentifierDefinitionRequest? updateIdentifierDefinitionRequest=default(UpdateIdentifierDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition. More...

async System.Threading.Tasks.Task< IdentifierDefinition >	UpdateIdentifierDefinitionAsync (string domain, string identifierScope, string identifierType, UpdateIdentifierDefinitionRequest? updateIdentifierDefinitionRequest=default(UpdateIdentifierDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< IdentifierDefinition > >	UpdateIdentifierDefinitionWithHttpInfoAsync (string domain, string identifierScope, string identifierType, UpdateIdentifierDefinitionRequest? updateIdentifierDefinitionRequest=default(UpdateIdentifierDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition. 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...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ IdentifierDefinitionsApi() [1/4]

Lusid.Sdk.Api.IdentifierDefinitionsApi.IdentifierDefinitionsApi ( )

inline

Initializes a new instance of the IdentifierDefinitionsApi class.

Returns

◆ IdentifierDefinitionsApi() [2/4]

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

inline

Initializes a new instance of the IdentifierDefinitionsApi class.

Returns

◆ IdentifierDefinitionsApi() [3/4]

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

inline

Initializes a new instance of the IdentifierDefinitionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ IdentifierDefinitionsApi() [4/4]

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

inline

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

◆ CreateIdentifierDefinition()

IdentifierDefinition Lusid.Sdk.Api.IdentifierDefinitionsApi.CreateIdentifierDefinition	(	CreateIdentifierDefinitionRequest?	createIdentifierDefinitionRequest = `default(CreateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition

Exceptions

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

Parameters

createIdentifierDefinitionRequest	The request defining the new definition (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ CreateIdentifierDefinitionAsync()

async System.Threading.Tasks.Task<IdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.CreateIdentifierDefinitionAsync	(	CreateIdentifierDefinitionRequest?	createIdentifierDefinitionRequest = `default(CreateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition

Exceptions

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

Parameters

createIdentifierDefinitionRequest	The request defining the new definition (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ CreateIdentifierDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.CreateIdentifierDefinitionWithHttpInfo	(	CreateIdentifierDefinitionRequest?	createIdentifierDefinitionRequest = `default(CreateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition

Exceptions

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

Parameters

createIdentifierDefinitionRequest	The request defining the new definition (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ CreateIdentifierDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> > Lusid.Sdk.Api.IdentifierDefinitionsApi.CreateIdentifierDefinitionWithHttpInfoAsync	(	CreateIdentifierDefinitionRequest?	createIdentifierDefinitionRequest = `default(CreateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition Define a new Identifier Definition

Exceptions

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

Parameters

createIdentifierDefinitionRequest	The request defining the new definition (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (IdentifierDefinition)

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ DeleteIdentifierDefinition()

DeletedEntityResponse Lusid.Sdk.Api.IdentifierDefinitionsApi.DeleteIdentifierDefinition	(	string	domain,
		string	identifierScope,
		string	identifierType,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ DeleteIdentifierDefinitionAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IdentifierDefinitionsApi.DeleteIdentifierDefinitionAsync	(	string	domain,
		string	identifierScope,
		string	identifierType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ DeleteIdentifierDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IdentifierDefinitionsApi.DeleteIdentifierDefinitionWithHttpInfo	(	string	domain,
		string	identifierScope,
		string	identifierType,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ DeleteIdentifierDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IdentifierDefinitionsApi.DeleteIdentifierDefinitionWithHttpInfoAsync	(	string	domain,
		string	identifierScope,
		string	identifierType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ GetIdentifierDefinition()

IdentifierDefinition Lusid.Sdk.Api.IdentifierDefinitionsApi.GetIdentifierDefinition	(	string	domain,
		string	identifierScope,
		string	identifierType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
asAt	The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ GetIdentifierDefinitionAsync()

async System.Threading.Tasks.Task<IdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.GetIdentifierDefinitionAsync	(	string	domain,
		string	identifierScope,
		string	identifierType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
asAt	The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ GetIdentifierDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.GetIdentifierDefinitionWithHttpInfo	(	string	domain,
		string	identifierScope,
		string	identifierType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
asAt	The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ GetIdentifierDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> > Lusid.Sdk.Api.IdentifierDefinitionsApi.GetIdentifierDefinitionWithHttpInfoAsync	(	string	domain,
		string	identifierScope,
		string	identifierType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition
asAt	The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (IdentifierDefinition)

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ ListIdentifierDefinitions()

PagedResourceListOfIdentifierDefinition Lusid.Sdk.Api.IdentifierDefinitionsApi.ListIdentifierDefinitions	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination

Exceptions

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

Parameters

effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
asAt	The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified. (optional)
page	The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many per page. (optional)
filter	Expression to filter the result set. 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)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfIdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ ListIdentifierDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfIdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.ListIdentifierDefinitionsAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination

Exceptions

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

Parameters

effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
asAt	The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified. (optional)
page	The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many per page. (optional)
filter	Expression to filter the result set. 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)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfIdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ ListIdentifierDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfIdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.ListIdentifierDefinitionsWithHttpInfo	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination

Exceptions

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

Parameters

effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
asAt	The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified. (optional)
page	The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many per page. (optional)
filter	Expression to filter the result set. 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)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfIdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ ListIdentifierDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfIdentifierDefinition> > Lusid.Sdk.Api.IdentifierDefinitionsApi.ListIdentifierDefinitionsWithHttpInfoAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination

Exceptions

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

Parameters

effectiveAt	The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition. (optional)
asAt	The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified. (optional)
page	The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many per page. (optional)
filter	Expression to filter the result set. 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)
propertyKeys	A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfIdentifierDefinition)

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ UpdateIdentifierDefinition()

IdentifierDefinition Lusid.Sdk.Api.IdentifierDefinitionsApi.UpdateIdentifierDefinition	(	string	domain,
		string	identifierScope,
		string	identifierType,
		UpdateIdentifierDefinitionRequest?	updateIdentifierDefinitionRequest = `default(UpdateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the Identifier Definition
updateIdentifierDefinitionRequest	The request containing the updated details of the Identifier Definition. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ UpdateIdentifierDefinitionAsync()

async System.Threading.Tasks.Task<IdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.UpdateIdentifierDefinitionAsync	(	string	domain,
		string	identifierScope,
		string	identifierType,
		UpdateIdentifierDefinitionRequest?	updateIdentifierDefinitionRequest = `default(UpdateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the Identifier Definition
updateIdentifierDefinitionRequest	The request containing the updated details of the Identifier Definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

◆ UpdateIdentifierDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> Lusid.Sdk.Api.IdentifierDefinitionsApi.UpdateIdentifierDefinitionWithHttpInfo	(	string	domain,
		string	identifierScope,
		string	identifierType,
		UpdateIdentifierDefinitionRequest?	updateIdentifierDefinitionRequest = `default(UpdateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the Identifier Definition
updateIdentifierDefinitionRequest	The request containing the updated details of the Identifier Definition. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of IdentifierDefinition

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.

◆ UpdateIdentifierDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> > Lusid.Sdk.Api.IdentifierDefinitionsApi.UpdateIdentifierDefinitionWithHttpInfoAsync	(	string	domain,
		string	identifierScope,
		string	identifierType,
		UpdateIdentifierDefinitionRequest?	updateIdentifierDefinitionRequest = `default(UpdateIdentifierDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType Overwrites an existing Identifier Definition.

Exceptions

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

Parameters

domain	The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
identifierScope	The scope that the identifier exists in
identifierType	What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the Identifier Definition
updateIdentifierDefinitionRequest	The request containing the updated details of the Identifier Definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (IdentifierDefinition)

Implements Lusid.Sdk.Api.IIdentifierDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.IdentifierDefinitionsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.IdentifierDefinitionsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.IdentifierDefinitionsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ IdentifierDefinitionsApi() [1/4]

◆ IdentifierDefinitionsApi() [2/4]

◆ IdentifierDefinitionsApi() [3/4]

◆ IdentifierDefinitionsApi() [4/4]

Member Function Documentation

◆ CreateIdentifierDefinition()

◆ CreateIdentifierDefinitionAsync()

◆ CreateIdentifierDefinitionWithHttpInfo()

◆ CreateIdentifierDefinitionWithHttpInfoAsync()

◆ DeleteIdentifierDefinition()

◆ DeleteIdentifierDefinitionAsync()

◆ DeleteIdentifierDefinitionWithHttpInfo()

◆ DeleteIdentifierDefinitionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetIdentifierDefinition()

◆ GetIdentifierDefinitionAsync()

◆ GetIdentifierDefinitionWithHttpInfo()

◆ GetIdentifierDefinitionWithHttpInfoAsync()

◆ ListIdentifierDefinitions()

◆ ListIdentifierDefinitionsAsync()

◆ ListIdentifierDefinitionsWithHttpInfo()

◆ ListIdentifierDefinitionsWithHttpInfoAsync()

◆ UpdateIdentifierDefinition()

◆ UpdateIdentifierDefinitionAsync()

◆ UpdateIdentifierDefinitionWithHttpInfo()

◆ UpdateIdentifierDefinitionWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory