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

Inheritance diagram for Lusid.Sdk.Api.IIdentifierDefinitionsApiSync:

[legend]

Public Member Functions
IdentifierDefinition	CreateIdentifierDefinition (CreateIdentifierDefinitionRequest? createIdentifierDefinitionRequest=default(CreateIdentifierDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateIdentifierDefinition: Create an 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 More...

DeletedEntityResponse	DeleteIdentifierDefinition (string domain, string identifierScope, string identifierType, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition 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 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 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 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 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 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 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 More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateIdentifierDefinition()

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

[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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ CreateIdentifierDefinitionWithHttpInfo()

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

[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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ DeleteIdentifierDefinition()

DeletedEntityResponse Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ DeleteIdentifierDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ GetIdentifierDefinition()

IdentifierDefinition Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ GetIdentifierDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ ListIdentifierDefinitions()

PagedResourceListOfIdentifierDefinition Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ ListIdentifierDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfIdentifierDefinition> Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ UpdateIdentifierDefinition()

IdentifierDefinition Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

◆ UpdateIdentifierDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<IdentifierDefinition> Lusid.Sdk.Api.IIdentifierDefinitionsApiSync.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.

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

Implemented in Lusid.Sdk.Api.IdentifierDefinitionsApi.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateIdentifierDefinition()

◆ CreateIdentifierDefinitionWithHttpInfo()

◆ DeleteIdentifierDefinition()

◆ DeleteIdentifierDefinitionWithHttpInfo()

◆ GetIdentifierDefinition()

◆ GetIdentifierDefinitionWithHttpInfo()

◆ ListIdentifierDefinitions()

◆ ListIdentifierDefinitionsWithHttpInfo()

◆ UpdateIdentifierDefinition()

◆ UpdateIdentifierDefinitionWithHttpInfo()