Skip to content

Latest commit

 

History

History
228 lines (160 loc) · 7.61 KB

General.Contacts.PartyRelationships.md

File metadata and controls

228 lines (160 loc) · 7.61 KB
Raw
uid
General.Contacts.PartyRelationships

General.Contacts.PartyRelationships Entity

Namespace: General.Contacts

Defines the relationships between the parties. The data is preserved over time. Entity: Cm_Party_Relationships

Default Visualization

Default Display Text Format:
{Id}: {FromPartyId}
Default Search Members:
__
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate datetime nullable The starting date of the relationship. null means the date is the begining of the time. Filter(ge;le)
Id guid
Notes string (254) nullable Notes for this PartyRelationship.
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.
ToDate datetime nullable The ending date of the relationship. null means the relationship is still active. Filter(ge;le)

References

Name Type Description
FromParty Parties The first party in the relationship. Required Filter(multi eq)
RelationshipType PartyRelationshipTypes The type of the relationship. Required Filter(multi eq)
ToParty Parties The second party in the relationship. Required Filter(multi eq)

Attribute Details

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

FromDate

The starting date of the relationship. null means the date is the begining of the time. Filter(ge;le)

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

Id

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

Notes

Notes for this PartyRelationship.

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

ToDate

The ending date of the relationship. null means the relationship is still active. Filter(ge;le)

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

Reference Details

FromParty

The first party in the relationship. Required Filter(multi eq)

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

RelationshipType

The type of the relationship. Required Filter(multi eq)

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

ToParty

The second party in the relationship. Required Filter(multi eq)

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

Creates a notification and sends 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 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

[!list limit=1000 erp.entity=General.Contacts.PartyRelationships erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=General.Contacts.PartyRelationships erp.type=front-end-business-rule default-text="None"]

API

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

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