A list of property definitions. More...

Inheritance diagram for Lusid.Sdk.Model.PropertyDefinition:

Public Types
enum class	ValueTypeEnum { String = 1 , Int = 2 , Decimal = 3 , DateTime = 4 , Boolean = 5 , Map = 6 , List = 7 , PropertyArray = 8 , Percentage = 9 , Code = 10 , Id = 11 , Uri = 12 , CurrencyAndAmount = 13 , TradePrice = 14 , Currency = 15 , MetricValue = 16 , ResourceId = 17 , ResultValue = 18 , CutLocalTime = 19 , DateOrCutLabel = 20 , UnindexedText = 21 }
	The type of values that can be associated with this property. This is defined by the property's data type. Available values: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText. More...

enum class	TypeEnum { Label = 1 , Metric = 2 , Information = 3 }
	The type of the property. Available values: Label, Metric, Information. More...

enum class	UnitSchemaEnum { NoUnits = 1 , Basic = 2 , Iso4217Currency = 3 }
	The units that can be associated with the property's values. This is defined by the property's data type. Available values: NoUnits, Basic, Iso4217Currency. More...

enum class	DomainEnum { NotDefined = 1 , Transaction = 2 , Portfolio = 3 , Holding = 4 , ReferenceHolding = 5 , TransactionConfiguration = 6 , Instrument = 7 , CutLabelDefinition = 8 , Analytic = 9 , PortfolioGroup = 10 , Person = 11 , AccessMetadata = 12 , Order = 13 , UnitResult = 14 , MarketData = 15 , ConfigurationRecipe = 16 , Allocation = 17 , Calendar = 18 , LegalEntity = 19 , InvestorRecord = 20 , InvestmentAccount = 21 , Placement = 22 , Execution = 23 , Block = 24 , Participation = 25 , Package = 26 , OrderInstruction = 27 , NextBestAction = 28 , CustomEntity = 29 , InstrumentEvent = 30 , Account = 31 , ChartOfAccounts = 32 , CustodianAccount = 33 , CheckDefinition = 34 , Abor = 35 , AborConfiguration = 36 , Fund = 37 , FundConfiguration = 38 , Fee = 39 , Reconciliation = 40 , PropertyDefinition = 41 , Compliance = 42 , DiaryEntry = 43 , Leg = 44 , DerivedValuation = 45 , Timeline = 46 , ClosedPeriod = 47 , AddressKeyDefinition = 48 , AmortisationRuleSet = 49 , AnalyticsSetInventory = 50 , AtomUnitResult = 51 , CleardownModule = 52 , ComplexMarketData = 53 , ComplianceRunSummary = 54 , ComplianceRule = 55 , ComplianceRunInfo = 56 , CorporateActionSource = 57 , CounterpartyAgreement = 58 , CustomEntityDefinition = 59 , DataType = 60 , Dialect = 61 , EventHandler = 62 , GeneralLedgerProfile = 63 , PostingModule = 64 , Quote = 65 , RecipeComposer = 66 , ReconciliationRunBreak = 67 , ReferenceList = 68 , RelationDefinition = 69 , ReturnBlockIndex = 70 , SRSDocument = 71 , SRSIndex = 72 , TransactionTemplate = 73 , TransactionTemplateScope = 74 , TransactionType = 75 , TransactionTypeConfig = 76 , TranslationScript = 77 , TaskDefinition = 78 , TaskInstance = 79 , Worker = 80 , StagingRuleSet = 81 , IdentifierDefinition = 82 , SettlementInstruction = 83 , TransactionFeeType = 84 , AllocationMethod = 85 , TransactionFee = 86 }
	The domain that the property exists in. 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. More...

enum class	LifeTimeEnum { Perpetual = 1 , TimeVariant = 2 }
	Describes how the property's values can change over time. Available values: Perpetual, TimeVariant. More...

enum class	PropertyDefinitionTypeEnum { ValueProperty = 1 , DerivedDefinition = 2 }
	The definition type. Available values: ValueProperty, DerivedDefinition. More...

Public Member Functions
	PropertyDefinition (string href=default(string), string key=default(string), ValueTypeEnum ?valueType=default(ValueTypeEnum?), string displayName=default(string), ResourceId dataTypeId=default(ResourceId), TypeEnum ?type=default(TypeEnum?), UnitSchemaEnum ?unitSchema=default(UnitSchemaEnum?), DomainEnum ?domain=default(DomainEnum?), bool valueRequired=default(bool), LifeTimeEnum ?lifeTime=default(LifeTimeEnum?), string constraintStyle=default(string), PropertyDefinitionTypeEnum ?propertyDefinitionType=default(PropertyDefinitionTypeEnum?), string propertyDescription=default(string), string derivationFormula=default(string), string collectionType=default(string), Dictionary< string, Property > properties=default(Dictionary< string, Property >), ModelVersion varVersion=default(ModelVersion), StagedModificationsInfo stagedModifications=default(StagedModificationsInfo), bool isFilterable=default(bool), List< string > customEntityTypes=default(List< string >), string valueFormat=default(string), List< Link > links=default(List< Link >))
	Initializes a new instance of the PropertyDefinition class. More...

bool	ShouldSerializeScope ()
	Returns false as Scope should not be serialized given that it's read-only. More...

bool	ShouldSerializeCode ()
	Returns false as Code should not be serialized given that it's read-only. More...

override string	ToString ()
	Returns the string presentation of the object More...

virtual string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (PropertyDefinition input)
	Returns true if PropertyDefinition instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Properties
ValueTypeEnum?	ValueType `[get, set]`
	The type of values that can be associated with this property. This is defined by the property's data type. Available values: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText. More...

TypeEnum?	Type `[get, set]`
	The type of the property. Available values: Label, Metric, Information. More...

UnitSchemaEnum?	UnitSchema `[get, set]`
	The units that can be associated with the property's values. This is defined by the property's data type. Available values: NoUnits, Basic, Iso4217Currency. More...

DomainEnum?	Domain `[get, set]`
	The domain that the property exists in. 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. More...

LifeTimeEnum?	LifeTime `[get, set]`
	Describes how the property's values can change over time. Available values: Perpetual, TimeVariant. More...

PropertyDefinitionTypeEnum?	PropertyDefinitionType `[get, set]`
	The definition type. Available values: ValueProperty, DerivedDefinition. More...

string	Href `[get, set]`
	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...

string	Key `[get, set]`
	The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'. More...

string	DisplayName `[get, set]`
	The display name of the property. More...

ResourceId	DataTypeId `[get, set]`
	Gets or Sets DataTypeId More...

string	Scope `[get]`
	The scope that the property exists in. More...

string	Code `[get]`
	The code of the property. Together with the domain and scope this uniquely identifies the property. More...

bool	ValueRequired `[get, set]`
	This field is not implemented and should be disregarded. More...

string	ConstraintStyle `[get, set]`
	Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. More...

string	PropertyDescription `[get, set]`
	A brief description of what a property of this property definition contains. More...

string	DerivationFormula `[get, set]`
	The rule that defines how data is composed for a derived property. More...

string	CollectionType `[get, set]`
	Describes whether a collection property should behave as a Set or as an Array. More...

Dictionary< string, Property >	Properties `[get, set]`
	Set of unique property definition properties and associated values to store with the property definition. Each property must be from the 'PropertyDefinition' domain. More...

ModelVersion	VarVersion `[get, set]`
	Gets or Sets VarVersion More...

StagedModificationsInfo	StagedModifications `[get, set]`
	Gets or Sets StagedModifications More...

bool	IsFilterable `[get, set]`
	Bool indicating whether the values of this property are fitlerable, this is true for all non-derived property defintions. For a derived definition this must be set true to enable filtering. More...

List< string >	CustomEntityTypes `[get, set]`
	The custom entity types that properties relating to this property definition can be applied to. More...

string	ValueFormat `[get, set]`
	The format in which values for this property definition should be represented. More...

List< Link >	Links `[get, set]`
	Gets or Sets Links More...

Detailed Description

A list of property definitions.

Member Enumeration Documentation

◆ DomainEnum

enum Lusid.Sdk.Model.PropertyDefinition.DomainEnum

strong

The domain that the property exists in. 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.

Enumerator
NotDefined	Enum NotDefined for value: NotDefined
Transaction	Enum Transaction for value: Transaction
Portfolio	Enum Portfolio for value: Portfolio
Holding	Enum Holding for value: Holding
ReferenceHolding	Enum ReferenceHolding for value: ReferenceHolding
TransactionConfiguration	Enum TransactionConfiguration for value: TransactionConfiguration
Instrument	Enum Instrument for value: Instrument
CutLabelDefinition	Enum CutLabelDefinition for value: CutLabelDefinition
Analytic	Enum Analytic for value: Analytic
PortfolioGroup	Enum PortfolioGroup for value: PortfolioGroup
Person	Enum Person for value: Person
AccessMetadata	Enum AccessMetadata for value: AccessMetadata
Order	Enum Order for value: Order
UnitResult	Enum UnitResult for value: UnitResult
MarketData	Enum MarketData for value: MarketData
ConfigurationRecipe	Enum ConfigurationRecipe for value: ConfigurationRecipe
Allocation	Enum Allocation for value: Allocation
Calendar	Enum Calendar for value: Calendar
LegalEntity	Enum LegalEntity for value: LegalEntity
InvestorRecord	Enum InvestorRecord for value: InvestorRecord
InvestmentAccount	Enum InvestmentAccount for value: InvestmentAccount
Placement	Enum Placement for value: Placement
Execution	Enum Execution for value: Execution
Block	Enum Block for value: Block
Participation	Enum Participation for value: Participation
Package	Enum Package for value: Package
OrderInstruction	Enum OrderInstruction for value: OrderInstruction
NextBestAction	Enum NextBestAction for value: NextBestAction
CustomEntity	Enum CustomEntity for value: CustomEntity
InstrumentEvent	Enum InstrumentEvent for value: InstrumentEvent
Account	Enum Account for value: Account
ChartOfAccounts	Enum ChartOfAccounts for value: ChartOfAccounts
CustodianAccount	Enum CustodianAccount for value: CustodianAccount
CheckDefinition	Enum CheckDefinition for value: CheckDefinition
Abor	Enum Abor for value: Abor
AborConfiguration	Enum AborConfiguration for value: AborConfiguration
Fund	Enum Fund for value: Fund
FundConfiguration	Enum FundConfiguration for value: FundConfiguration
Fee	Enum Fee for value: Fee
Reconciliation	Enum Reconciliation for value: Reconciliation
PropertyDefinition	Enum PropertyDefinition for value: PropertyDefinition
Compliance	Enum Compliance for value: Compliance
DiaryEntry	Enum DiaryEntry for value: DiaryEntry
Leg	Enum Leg for value: Leg
DerivedValuation	Enum DerivedValuation for value: DerivedValuation
Timeline	Enum Timeline for value: Timeline
ClosedPeriod	Enum ClosedPeriod for value: ClosedPeriod
AddressKeyDefinition	Enum AddressKeyDefinition for value: AddressKeyDefinition
AmortisationRuleSet	Enum AmortisationRuleSet for value: AmortisationRuleSet
AnalyticsSetInventory	Enum AnalyticsSetInventory for value: AnalyticsSetInventory
AtomUnitResult	Enum AtomUnitResult for value: AtomUnitResult
CleardownModule	Enum CleardownModule for value: CleardownModule
ComplexMarketData	Enum ComplexMarketData for value: ComplexMarketData
ComplianceRunSummary	Enum ComplianceRunSummary for value: ComplianceRunSummary
ComplianceRule	Enum ComplianceRule for value: ComplianceRule
ComplianceRunInfo	Enum ComplianceRunInfo for value: ComplianceRunInfo
CorporateActionSource	Enum CorporateActionSource for value: CorporateActionSource
CounterpartyAgreement	Enum CounterpartyAgreement for value: CounterpartyAgreement
CustomEntityDefinition	Enum CustomEntityDefinition for value: CustomEntityDefinition
DataType	Enum DataType for value: DataType
Dialect	Enum Dialect for value: Dialect
EventHandler	Enum EventHandler for value: EventHandler
GeneralLedgerProfile	Enum GeneralLedgerProfile for value: GeneralLedgerProfile
PostingModule	Enum PostingModule for value: PostingModule
Quote	Enum Quote for value: Quote
RecipeComposer	Enum RecipeComposer for value: RecipeComposer
ReconciliationRunBreak	Enum ReconciliationRunBreak for value: ReconciliationRunBreak
ReferenceList	Enum ReferenceList for value: ReferenceList
RelationDefinition	Enum RelationDefinition for value: RelationDefinition
ReturnBlockIndex	Enum ReturnBlockIndex for value: ReturnBlockIndex
SRSDocument	Enum SRSDocument for value: SRSDocument
SRSIndex	Enum SRSIndex for value: SRSIndex
TransactionTemplate	Enum TransactionTemplate for value: TransactionTemplate
TransactionTemplateScope	Enum TransactionTemplateScope for value: TransactionTemplateScope
TransactionType	Enum TransactionType for value: TransactionType
TransactionTypeConfig	Enum TransactionTypeConfig for value: TransactionTypeConfig
TranslationScript	Enum TranslationScript for value: TranslationScript
TaskDefinition	Enum TaskDefinition for value: TaskDefinition
TaskInstance	Enum TaskInstance for value: TaskInstance
Worker	Enum Worker for value: Worker
StagingRuleSet	Enum StagingRuleSet for value: StagingRuleSet
IdentifierDefinition	Enum IdentifierDefinition for value: IdentifierDefinition
SettlementInstruction	Enum SettlementInstruction for value: SettlementInstruction
TransactionFeeType	Enum TransactionFeeType for value: TransactionFeeType
AllocationMethod	Enum AllocationMethod for value: AllocationMethod
TransactionFee	Enum TransactionFee for value: TransactionFee

◆ LifeTimeEnum

enum Lusid.Sdk.Model.PropertyDefinition.LifeTimeEnum

strong

Describes how the property's values can change over time. Available values: Perpetual, TimeVariant.

Enumerator
Perpetual	Enum Perpetual for value: Perpetual
TimeVariant	Enum TimeVariant for value: TimeVariant

◆ PropertyDefinitionTypeEnum

enum Lusid.Sdk.Model.PropertyDefinition.PropertyDefinitionTypeEnum

strong

The definition type. Available values: ValueProperty, DerivedDefinition.

Enumerator
ValueProperty	Enum ValueProperty for value: ValueProperty
DerivedDefinition	Enum DerivedDefinition for value: DerivedDefinition

◆ TypeEnum

enum Lusid.Sdk.Model.PropertyDefinition.TypeEnum

strong

The type of the property. Available values: Label, Metric, Information.

Enumerator
Label	Enum Label for value: Label
Metric	Enum Metric for value: Metric
Information	Enum Information for value: Information

◆ UnitSchemaEnum

enum Lusid.Sdk.Model.PropertyDefinition.UnitSchemaEnum

strong

The units that can be associated with the property's values. This is defined by the property's data type. Available values: NoUnits, Basic, Iso4217Currency.

Enumerator
NoUnits	Enum NoUnits for value: NoUnits
Basic	Enum Basic for value: Basic
Iso4217Currency	Enum Iso4217Currency for value: Iso4217Currency

◆ ValueTypeEnum

enum Lusid.Sdk.Model.PropertyDefinition.ValueTypeEnum

strong

The type of values that can be associated with this property. This is defined by the property's data type. Available values: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText.

Enumerator
String	Enum String for value: String
Int	Enum Int for value: Int
Decimal	Enum Decimal for value: Decimal
DateTime	Enum DateTime for value: DateTime
Boolean	Enum Boolean for value: Boolean
Map	Enum Map for value: Map
List	Enum List for value: List
PropertyArray	Enum PropertyArray for value: PropertyArray
Percentage	Enum Percentage for value: Percentage
Code	Enum Code for value: Code
Id	Enum Id for value: Id
Uri	Enum Uri for value: Uri
CurrencyAndAmount	Enum CurrencyAndAmount for value: CurrencyAndAmount
TradePrice	Enum TradePrice for value: TradePrice
Currency	Enum Currency for value: Currency
MetricValue	Enum MetricValue for value: MetricValue
ResourceId	Enum ResourceId for value: ResourceId
ResultValue	Enum ResultValue for value: ResultValue
CutLocalTime	Enum CutLocalTime for value: CutLocalTime
DateOrCutLabel	Enum DateOrCutLabel for value: DateOrCutLabel
UnindexedText	Enum UnindexedText for value: UnindexedText

Constructor & Destructor Documentation

◆ PropertyDefinition()

Lusid.Sdk.Model.PropertyDefinition.PropertyDefinition	(	string	href = `default(string)`,
		string	key = `default(string)`,
		ValueTypeEnum ?	valueType = `default(ValueTypeEnum?)`,
		string	displayName = `default(string)`,
		ResourceId	dataTypeId = `default(ResourceId)`,
		TypeEnum ?	type = `default(TypeEnum?)`,
		UnitSchemaEnum ?	unitSchema = `default(UnitSchemaEnum?)`,
		DomainEnum ?	domain = `default(DomainEnum?)`,
		bool	valueRequired = `default(bool)`,
		LifeTimeEnum ?	lifeTime = `default(LifeTimeEnum?)`,
		string	constraintStyle = `default(string)`,
		PropertyDefinitionTypeEnum ?	propertyDefinitionType = `default(PropertyDefinitionTypeEnum?)`,
		string	propertyDescription = `default(string)`,
		string	derivationFormula = `default(string)`,
		string	collectionType = `default(string)`,
		Dictionary< string, Property >	properties = `default(Dictionary<string, Property>)`,
		ModelVersion	varVersion = `default(ModelVersion)`,
		StagedModificationsInfo	stagedModifications = `default(StagedModificationsInfo)`,
		bool	isFilterable = `default(bool)`,
		List< string >	customEntityTypes = `default(List<string>)`,
		string	valueFormat = `default(string)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the PropertyDefinition class.

Parameters

href	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
key	The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'..
valueType	The type of values that can be associated with this property. This is defined by the property's data type. Available values: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText..
displayName	The display name of the property..
dataTypeId	dataTypeId.
type	The type of the property. Available values: Label, Metric, Information..
unitSchema	The units that can be associated with the property's values. This is defined by the property's data type. Available values: NoUnits, Basic, Iso4217Currency..
domain	The domain that the property exists in. 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..
valueRequired	This field is not implemented and should be disregarded..
lifeTime	Describes how the property's values can change over time. Available values: Perpetual, TimeVariant..
constraintStyle	Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key..
propertyDefinitionType	The definition type. Available values: ValueProperty, DerivedDefinition..
propertyDescription	A brief description of what a property of this property definition contains..
derivationFormula	The rule that defines how data is composed for a derived property..
collectionType	Describes whether a collection property should behave as a Set or as an Array..
properties	Set of unique property definition properties and associated values to store with the property definition. Each property must be from the 'PropertyDefinition' domain..
varVersion	varVersion.
stagedModifications	stagedModifications.
isFilterable	Bool indicating whether the values of this property are fitlerable, this is true for all non-derived property defintions. For a derived definition this must be set true to enable filtering..
customEntityTypes	The custom entity types that properties relating to this property definition can be applied to..
valueFormat	The format in which values for this property definition should be represented..
links	links.

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.PropertyDefinition.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.PropertyDefinition.Equals ( PropertyDefinition input )

inline

Returns true if PropertyDefinition instances are equal

Parameters

input Instance of PropertyDefinition to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.PropertyDefinition.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ShouldSerializeCode()

bool Lusid.Sdk.Model.PropertyDefinition.ShouldSerializeCode ( )

inline

Returns false as Code should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ShouldSerializeScope()

bool Lusid.Sdk.Model.PropertyDefinition.ShouldSerializeScope ( )

inline

Returns false as Scope should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ToJson()

virtual string Lusid.Sdk.Model.PropertyDefinition.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.PropertyDefinition.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.PropertyDefinition.Code

get

The code of the property. Together with the domain and scope this uniquely identifies the property.

◆ CollectionType

string Lusid.Sdk.Model.PropertyDefinition.CollectionType

getset

Describes whether a collection property should behave as a Set or as an Array.

◆ ConstraintStyle

string Lusid.Sdk.Model.PropertyDefinition.ConstraintStyle

getset

Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key.

◆ CustomEntityTypes

List<string> Lusid.Sdk.Model.PropertyDefinition.CustomEntityTypes

getset

The custom entity types that properties relating to this property definition can be applied to.

◆ DataTypeId

ResourceId Lusid.Sdk.Model.PropertyDefinition.DataTypeId

getset

Gets or Sets DataTypeId

◆ DerivationFormula

string Lusid.Sdk.Model.PropertyDefinition.DerivationFormula

getset

The rule that defines how data is composed for a derived property.

◆ DisplayName

string Lusid.Sdk.Model.PropertyDefinition.DisplayName

getset

The display name of the property.

◆ Domain

DomainEnum? Lusid.Sdk.Model.PropertyDefinition.Domain

getset

The domain that the property exists in. 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.

◆ Href

string Lusid.Sdk.Model.PropertyDefinition.Href

getset

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

◆ IsFilterable

bool Lusid.Sdk.Model.PropertyDefinition.IsFilterable

getset

Bool indicating whether the values of this property are fitlerable, this is true for all non-derived property defintions. For a derived definition this must be set true to enable filtering.

◆ Key

string Lusid.Sdk.Model.PropertyDefinition.Key

getset

The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'.

◆ LifeTime

LifeTimeEnum? Lusid.Sdk.Model.PropertyDefinition.LifeTime

getset

Describes how the property's values can change over time. Available values: Perpetual, TimeVariant.

◆ Links

List<Link> Lusid.Sdk.Model.PropertyDefinition.Links

getset

Gets or Sets Links

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.PropertyDefinition.Properties

getset

Set of unique property definition properties and associated values to store with the property definition. Each property must be from the 'PropertyDefinition' domain.

◆ PropertyDefinitionType

PropertyDefinitionTypeEnum? Lusid.Sdk.Model.PropertyDefinition.PropertyDefinitionType

getset

The definition type. Available values: ValueProperty, DerivedDefinition.

◆ PropertyDescription

string Lusid.Sdk.Model.PropertyDefinition.PropertyDescription

getset

A brief description of what a property of this property definition contains.

◆ Scope

string Lusid.Sdk.Model.PropertyDefinition.Scope

get

The scope that the property exists in.

◆ StagedModifications

StagedModificationsInfo Lusid.Sdk.Model.PropertyDefinition.StagedModifications

getset

Gets or Sets StagedModifications

◆ Type

TypeEnum? Lusid.Sdk.Model.PropertyDefinition.Type

getset

The type of the property. Available values: Label, Metric, Information.

◆ UnitSchema

UnitSchemaEnum? Lusid.Sdk.Model.PropertyDefinition.UnitSchema

getset

The units that can be associated with the property's values. This is defined by the property's data type. Available values: NoUnits, Basic, Iso4217Currency.

◆ ValueFormat

string Lusid.Sdk.Model.PropertyDefinition.ValueFormat

getset

The format in which values for this property definition should be represented.

◆ ValueRequired

bool Lusid.Sdk.Model.PropertyDefinition.ValueRequired

getset

This field is not implemented and should be disregarded.

◆ ValueType

ValueTypeEnum? Lusid.Sdk.Model.PropertyDefinition.ValueType

getset

The type of values that can be associated with this property. This is defined by the property's data type. Available values: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText.

◆ VarVersion

ModelVersion Lusid.Sdk.Model.PropertyDefinition.VarVersion

getset

Gets or Sets VarVersion

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/Model/PropertyDefinition.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ DomainEnum

◆ LifeTimeEnum

◆ PropertyDefinitionTypeEnum

◆ TypeEnum

◆ UnitSchemaEnum

◆ ValueTypeEnum

Constructor & Destructor Documentation

◆ PropertyDefinition()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ShouldSerializeCode()

◆ ShouldSerializeScope()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Code

◆ CollectionType

◆ ConstraintStyle

◆ CustomEntityTypes

◆ DataTypeId

◆ DerivationFormula

◆ DisplayName

◆ Domain

◆ Href

◆ IsFilterable

◆ Key

◆ LifeTime

◆ Links

◆ Properties

◆ PropertyDefinitionType

◆ PropertyDescription

◆ Scope

◆ StagedModifications

◆ Type

◆ UnitSchema

◆ ValueFormat

◆ ValueRequired

◆ ValueType

◆ VarVersion