Applications.Rental.AssetConsumables Entity

Consumables are products, which are usually sold accompanying an asset rental. Entity: Rent_Asset_Consumables

Default Visualization

Default Display Text Format:
{RentalAsset.RentalAssetName}
Default Search Members:
RentalAsset.RentalAssetName
Name Data Member:
RentalAsset.RentalAssetName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Applications.Rental.Assets
Aggregate Root:
Applications.Rental.Assets

Attributes

Name	Type	Description
ConsumableQuantity	Quantity (12, 3)	Specifies what quantity of the consumable should be offered for each rented asset. `Unit: ConsumableQuantityUnit` `Required`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Notes	string (max) nullable	Notes for this AssetConsumable.
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

References

Name	Type	Description
ConsumableQuantityUnit	MeasurementUnits	The measurement unit of Consumable Quantity. `Required` `Filter(multi eq)`
Product	Products	The consumable which is offered accompanying the asset rental. `Required` `Filter(multi eq)`
RentalAsset	Assets	The rental asset for which the consumable would be offered. `Required` `Filter(multi eq)` `Owner`
Store	Stores	The store which contains the consumable. `Required` `Filter(multi eq)`

Attribute Details

ConsumableQuantity

Specifies what quantity of the consumable should be offered for each rented asset. Unit: ConsumableQuantityUnit Required

Type: Quantity (12, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Notes

Notes for this AssetConsumable.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Reference Details

ConsumableQuantityUnit

The measurement unit of Consumable Quantity. Required Filter(multi eq)

Type: MeasurementUnits
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Product

The consumable which is offered accompanying the asset rental. Required Filter(multi eq)

Type: Products
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

RentalAsset

The rental asset for which the consumable would be offered. Required Filter(multi eq) Owner

Type: Assets
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

Store

The store which contains the consumable. Required Filter(multi eq)

Type: Stores
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST