Systems.Exchange.DataExchangeObjects Entity

Namespace: Systems.Exchange

Individual aggregate root objects transferred within the data exchange. Only aggregate root objects can be specified; sub-entities are specified as addresses within the root objects. Entity: Sys_Data_Exchange_Objects (Introduced in version 25.1.1.70)

Default Visualization

Default Display Text Format:
{DataExchange.Name}
Default Search Members:
DataExchange.Name
Name Data Member:
DataExchange.Name
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:
Systems.Exchange.DataExchanges
Aggregate Root:
Systems.Exchange.DataExchanges

Attributes

Name	Type	Description
CreatedOn	datetime	The time (in UTC) when the object is created. `Required` `Filter(ge;le)` `ReadOnly`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExchangeMessage	string (max) nullable	Status message for this object after the last exchange attempt. `Filter(like)`
ExchangeResult	ExchangeResult	Transfer status. `Required` `Default("N")` `Filter(eq)`
Id	guid
Mode	Mode	Operation mode for the object when transferring. `Required` `Default("MER")` `Filter(eq)`
Notes	string (max) nullable	Notes for the exchanged object. `Filter(like)`
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.
Reason	Reason	Reason for adding the object. `Required` `Default("C")` `Filter(eq)`

References

Name	Type	Description
DataExchange	DataExchanges	The exchange of the object. `Required` `Filter(multi eq)` `Owner`
DataObject	ExtensibleDataObjects	The data object which will be transferred. `Required` `Filter(multi eq)`

Attribute Details

CreatedOn

The time (in UTC) when the object is created. Required Filter(ge;le) ReadOnly

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

Back-End Default Expression:
DateTime.UtcNow

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

ExchangeMessage

Status message for this object after the last exchange attempt. Filter(like)

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

ExchangeResult

Transfer status. Required Default("N") Filter(eq)

Type: ExchangeResult
Category: System
Allowed values for the ExchangeResult(Systems.Exchange.DataExchangeObjects.md#exchangeresult) data attribute
Allowed Values (Systems.Exchange.DataExchangeObjectsRepository.ExchangeResult Enum Members)

Value	Description
NotStarted	Not started. Stored as 'N'. Database Value: 'N' Model Value: 0 Domain API Value: 'NotStarted'
Success	Success. Stored as 'S'. Database Value: 'S' Model Value: 1 Domain API Value: 'Success'
Fail	Fail. Stored as 'F'. Database Value: 'F' Model Value: 2 Domain API Value: 'Fail'

Supported Filters: Equals
Supports Order By: False
Default Value: NotStarted
Show in UI: ShownByDefault

Id

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

Mode

Operation mode for the object when transferring. Required Default("MER") Filter(eq)

Type: Mode
Category: System
Allowed values for the Mode(Systems.Exchange.DataExchangeObjects.md#mode) data attribute
Allowed Values (Systems.Exchange.DataExchangeObjectsRepository.Mode Enum Members)

Value	Description
Merge	Merge. Stored as 'MER'. Database Value: 'MER' Model Value: 0 Domain API Value: 'Merge'
Add	Add. Stored as 'ADD'. Database Value: 'ADD' Model Value: 1 Domain API Value: 'Add'

Supported Filters: Equals
Supports Order By: False
Default Value: Merge
Show in UI: ShownByDefault

Notes

Notes for the exchanged object. Filter(like)

Type: string (max) nullable
Category: System
Supported Filters: Like
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

Reason

Reason for adding the object. Required Default("C") Filter(eq)

Type: Reason
Category: System
Allowed values for the Reason(Systems.Exchange.DataExchangeObjects.md#reason) data attribute
Allowed Values (Systems.Exchange.DataExchangeObjectsRepository.Reason Enum Members)

Value	Description
CoreData	Core data. Stored as 'C'. Database Value: 'C' Model Value: 0 Domain API Value: 'CoreData'
ByReference	By Reference. Stored as 'R'. Database Value: 'R' Model Value: 1 Domain API Value: 'ByReference'
Other	Other. Stored as 'O'. Database Value: 'O' Model Value: 2 Domain API Value: 'Other'
Unknown	Unknown. Stored as 'U'. Database Value: 'U' Model Value: 3 Domain API Value: 'Unknown'

Supported Filters: Equals
Supports Order By: False
Default Value: CoreData
Show in UI: ShownByDefault

Reference Details

DataExchange

The exchange of the object. Required Filter(multi eq) Owner

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

DataObject

The data object which will be transferred. Required Filter(multi eq)

Type: ExtensibleDataObjects
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