LUSID C# SDK
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest Class Reference

CreateDerivedPropertyDefinitionRequest More...

Inheritance diagram for Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest:
Inheritance graph
[legend]

Public Types

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. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. 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...
 

Public Member Functions

 CreateDerivedPropertyDefinitionRequest (DomainEnum domain=default(DomainEnum), string scope=default(string), string code=default(string), string displayName=default(string), ResourceId dataTypeId=default(ResourceId), string propertyDescription=default(string), string derivationFormula=default(string), bool isFilterable=default(bool), string valueFormat=default(string), string customEntityType=default(string))
 Initializes a new instance of the CreateDerivedPropertyDefinitionRequest class. 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 (CreateDerivedPropertyDefinitionRequest input)
 Returns true if CreateDerivedPropertyDefinitionRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 CreateDerivedPropertyDefinitionRequest ()
 Initializes a new instance of the CreateDerivedPropertyDefinitionRequest class. More...
 

Properties

DomainEnum Domain [get, set]
 The domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. 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...
 
string Scope [get, set]
 The scope that the property exists in. More...
 
string Code [get, set]
 The code of the property. Together with the domain and scope this uniquely identifies the property. More...
 
string DisplayName [get, set]
 The display name of the property. More...
 
ResourceId DataTypeId [get, set]
 Gets or Sets DataTypeId More...
 
string PropertyDescription [get, set]
 Describes the property More...
 
string DerivationFormula [get, set]
 The rule that defines how data is composed for a derived property. 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...
 
string ValueFormat [get, set]
 The format in which values for this property definition should be represented. Available values: Text, Html. More...
 
string CustomEntityType [get, set]
 The custom entity type that this derived property definition can be applied to. More...
 

Detailed Description

CreateDerivedPropertyDefinitionRequest

Member Enumeration Documentation

◆ DomainEnum

The domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. 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.

The domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. 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

Constructor & Destructor Documentation

◆ CreateDerivedPropertyDefinitionRequest() [1/2]

Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.CreateDerivedPropertyDefinitionRequest ( )
inlineprotected

Initializes a new instance of the CreateDerivedPropertyDefinitionRequest class.

◆ CreateDerivedPropertyDefinitionRequest() [2/2]

Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.CreateDerivedPropertyDefinitionRequest ( DomainEnum  domain = default(DomainEnum),
string  scope = default(string),
string  code = default(string),
string  displayName = default(string),
ResourceId  dataTypeId = default(ResourceId),
string  propertyDescription = default(string),
string  derivationFormula = default(string),
bool  isFilterable = default(bool),
string  valueFormat = default(string),
string  customEntityType = default(string) 
)
inline

Initializes a new instance of the CreateDerivedPropertyDefinitionRequest class.

Parameters
domainThe domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. 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. (required).
scopeThe scope that the property exists in. (required).
codeThe code of the property. Together with the domain and scope this uniquely identifies the property. (required).
displayNameThe display name of the property. (required).
dataTypeIddataTypeId (required).
propertyDescriptionDescribes the property.
derivationFormulaThe rule that defines how data is composed for a derived property. (required).
isFilterableBool 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. (required).
valueFormatThe format in which values for this property definition should be represented. Available values: Text, Html..
customEntityTypeThe custom entity type that this derived property definition can be applied to..

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.Equals ( CreateDerivedPropertyDefinitionRequest  input)
inline

Returns true if CreateDerivedPropertyDefinitionRequest instances are equal

Parameters
inputInstance of CreateDerivedPropertyDefinitionRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.Code
getset

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

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

◆ CustomEntityType

string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.CustomEntityType
getset

The custom entity type that this derived property definition can be applied to.

The custom entity type that this derived property definition can be applied to.

◆ DataTypeId

ResourceId Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.DataTypeId
getset

Gets or Sets DataTypeId

◆ DerivationFormula

string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.DerivationFormula
getset

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

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

◆ DisplayName

string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.DisplayName
getset

The display name of the property.

The display name of the property.

◆ Domain

DomainEnum Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.Domain
getset

The domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. 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.

The domain that the property exists in. Not all available values are currently supported, please check the documentation: https://support.lusid.com/knowledgebase/article/KA-01719/. 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.

◆ IsFilterable

bool Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.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.

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.

◆ PropertyDescription

string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.PropertyDescription
getset

Describes the property

Describes the property

◆ Scope

string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.Scope
getset

The scope that the property exists in.

The scope that the property exists in.

◆ ValueFormat

string Lusid.Sdk.Model.CreateDerivedPropertyDefinitionRequest.ValueFormat
getset

The format in which values for this property definition should be represented. Available values: Text, Html.

The format in which values for this property definition should be represented. Available values: Text, Html.


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