Table of Contents

Applications.Fleet.VehicleObdTroubles Entity

Namespace: Applications.Fleet

Contains troubles, reported by the on-board diagnostics (OBD) of the vehicle. Entity: Fleet_Vehicle_Obd_Troubles

Default Visualization

Default Display Text Format:
{DiagnosticTroubleCode}
Default Search Members:
DiagnosticTroubleCode
Code Data Member:
DiagnosticTroubleCode
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 Tree

Attributes

Name Type Description
Details string (max) nullable Additional text, human-readable details for the trouble, generated by the hardware agent. Contains at least some summary data in English and optionally, locale-specific data.
DiagnosticTroubleCode string (5) Standartized OBD-II diagnostic trouble code. Required
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
ManufacturerTroubleCode string (16) nullable Non-standard manufacturer-specific trouble code. null when it is not available.
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.
OccurenceDateTime datetime Date and time (UTC) when the trouble was detected. Required Filter(ge;le)

References

Name Type Description
Vehicle Vehicles The vehicle, which has experienced the trouble. Required Filter(multi eq)

Attribute Details

Details

Additional text, human-readable details for the trouble, generated by the hardware agent. Contains at least some summary data in English and optionally, locale-specific data.

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

DiagnosticTroubleCode

Standartized OBD-II diagnostic trouble code. Required

Type: string (5)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 5
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: ShownByDefault

ManufacturerTroubleCode

Non-standard manufacturer-specific trouble code. null when it is not available.

Type: string (16) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 16
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

OccurenceDateTime

Date and time (UTC) when the trouble was detected. Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

Vehicle

The vehicle, which has experienced the trouble. Required Filter(multi eq)

Type: Vehicles
Indexed: True
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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Applications_Fleet_VehicleObdTroubles?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Applications_Fleet_VehicleObdTroubles?$top=10