General.Contacts.CompanyDepartments Entity

Namespace: General.Contacts

Hierarchical structure of the company departments. The departments and divisions are parallel and different structuring mechanisms for the companies. Entity: Cm_Company_Departments

Default Visualization

Default Display Text Format:
{DepartmentName}
Default Search Members:
DepartmentName
Name Data Member:
DepartmentName
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:
General.Contacts.Companies
Aggregate Root:
General.Contacts.Companies

Attributes

Name	Type	Description
DepartmentName	string (254)	The name of the department. Required Filter(like)
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 CompanyDepartment.
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
Company	Companies	The to which this CompanyDepartment belongs. Required Filter(multi eq) Owner
Parent	CompanyDepartments (nullable)	The parent department. null if this is root department in the company. Filter(multi eq)

Attribute Details

DepartmentName

The name of the department. Required Filter(like)

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

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

Company

The to which this CompanyDepartment belongs. Required Filter(multi eq) Owner

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

Parent

The parent department. null if this is root department in the company. Filter(multi eq)

Type: CompanyDepartments (nullable)
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/General_Contacts_CompanyDepartments?$top=10

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