# PropertyDefinitionSearchResult

A property definition search result
## Properties

| Name | Type | Required | Description |
|------|------|----------|-------------|
| **href** | **str** | Optional | The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. |
| **key** | **str** | Optional | The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. &#39;Portfolio/Manager/Id&#39;. |
| **value_type** | **str** | Optional | The type of values that can be associated with this property. This is defined by the property&#39;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. |
| **display_name** | **str** | Optional | The display name of the property. |
| **data_type_id** | [ResourceId](ResourceId.md) | Optional | *No description available.* |
| **type** | **str** | Optional | The type of the property. Available values: Label, Metric, Information. |
| **unit_schema** | **str** | Optional | The units that can be associated with the property&#39;s values. This is defined by the property&#39;s data type. Available values: NoUnits, Basic, Iso4217Currency. |
| **domain** | **str** | Optional | 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. |
| **scope** | **str** | Optional | The scope that the property exists in. *(read-only)* |
| **code** | **str** | Optional | The code of the property. Together with the domain and scope this uniquely identifies the property. *(read-only)* |
| **value_required** | **bool** | Optional | This field is not implemented and should be disregarded. |
| **life_time** | **str** | Optional | Describes how the property&#39;s values can change over time. Available values: Perpetual, TimeVariant. |
| **constraint_style** | **str** | Optional | Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. |
| **property_definition_type** | **str** | Optional | The definition type. Available values: ValueProperty, DerivedDefinition. |
| **property_description** | **str** | Optional | A brief description of what a property of this property definition contains. |
| **derivation_formula** | **str** | Optional | The rule that defines how data is composed for a derived property. |
| **is_filterable** | **bool** | Optional | 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. |
| **links** | [List[Link]](Link.md) | Optional | *No description available.* |


## Usage

### Creating from keyword arguments

```python
from finbourne.sdk.services.lusid.models.PropertyDefinitionSearchResult import PropertyDefinitionSearchResult

instance = PropertyDefinitionSearchResult(
    href="...",  # optional — The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.
    key="...",  # optional — The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. &#39;Portfolio/Manager/Id&#39;.
    value_type="...",  # optional — The type of values that can be associated with this property. This is defined by the property&#39;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.
    display_name="...",  # optional — The display name of the property.
    data_type_id=ResourceId(...),  # optional
    type="...",  # optional — The type of the property. Available values: Label, Metric, Information.
    unit_schema="...",  # optional — The units that can be associated with the property&#39;s values. This is defined by the property&#39;s data type. Available values: NoUnits, Basic, Iso4217Currency.
    domain="...",  # optional — 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.
    scope="...",  # optional — The scope that the property exists in.
    code="...",  # optional — The code of the property. Together with the domain and scope this uniquely identifies the property.
    value_required=True,  # optional — This field is not implemented and should be disregarded.
    life_time="...",  # optional — Describes how the property&#39;s values can change over time. Available values: Perpetual, TimeVariant.
    constraint_style="...",  # optional — Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key.
    property_definition_type="...",  # optional — The definition type. Available values: ValueProperty, DerivedDefinition.
    property_description="...",  # optional — A brief description of what a property of this property definition contains.
    derivation_formula="...",  # optional — The rule that defines how data is composed for a derived property.
    is_filterable=True,  # optional — 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.
    links=[]  # optional
)
```

- [ResourceId](ResourceId.md)
- [Link](Link.md)


[Back to top](#) · [Back to API list](../../api_endpoints.md) · [Back to Model list](../../models.md) · [Back to README](../../../../../README.md)

