Regulatory.Common.CodeEntries Entity

Namespace: Regulatory.Common

Code Entries. Entity: Reg_Code_Entries (Introduced in version 26.2.0.62)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault
API access: ReadWrite

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:
Regulatory.Common.CodeLists
Aggregate Root:
Regulatory.Common.CodeLists

Attributes

Name	Type	Description
AdditionalDataJson	string (max) nullable	Additional Data Json. Filter(eq;like)
AltCode	string (64) nullable	Optional alternative/legacy code if needed. Filter(eq;like)
Code	string (64)	The statutory code of the entry. The same code can appear multiple times for different validity periods. Required Filter(eq;like)
Data1	string (64) nullable	Data 1. Filter(eq;like)
Data2	string (64) nullable	Data 2. Filter(eq;like)
Data3	string (64) nullable	Data 3. Filter(eq;like)
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsActive	boolean	Specifies whether the code entry is active. Required Default(true) Filter(eq)
Name	MultilanguageString (254) nullable	Official (regulatory) name. Filter(like)
Notes	string (max) nullable	Notes for the entry. Filter(eq;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.
ShortName	MultilanguageString (64) nullable	Abbreviation, if such exists. Filter(like)
ValidFrom	date nullable	From when this entry is valid. Filter(eq;ge;le)
ValidTo	date nullable	Until when it is valid. Filter(eq;ge;le)

References

Name	Type	Description
CodeList	CodeLists	Code List. Required Filter(multi eq) Owner FilterableReference
ParentEntry	CodeEntries (nullable)	Parent entry for hierarchical lists (regions / subregions / groups). Filter(multi eq)

Attribute Details

AdditionalDataJson

Additional Data Json. Filter(eq;like)

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

AltCode

Optional alternative/legacy code if needed. Filter(eq;like)

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

Code

The statutory code of the entry. The same code can appear multiple times for different validity periods. Required Filter(eq;like)

Type: string (64)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Data1

Data 1. Filter(eq;like)

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

Data2

Data 2. Filter(eq;like)

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

Data3

Data 3. Filter(eq;like)

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

IsActive

Specifies whether the code entry is active. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Name

Official (regulatory) name. Filter(like)

Type: MultilanguageString (254) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for the entry. Filter(eq;like)

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

ShortName

Abbreviation, if such exists. Filter(like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

ValidFrom

From when this entry is valid. Filter(eq;ge;le)

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

ValidTo

Until when it is valid. Filter(eq;ge;le)

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

Reference Details

CodeList

Code List. Required Filter(multi eq) Owner FilterableReference

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

ParentEntry

Parent entry for hierarchical lists (regions / subregions / groups). Filter(multi eq)

Type: CodeEntries (nullable)
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

• priority
  The notification priority.
  Type: Systems.Core.NotificationsRepository.Priority
  Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
  Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

  Value	Description
  Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
  Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
  Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
  High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
  Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

  Optional: True
  Default Value: Normal

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 Entity Set: Regulatory_Common_CodeEntries

Domain API Entity Type: Regulatory_Common_CodeEntry

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

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