EGAIS counteragents in Main(EGAISClient_RU)

Article
02/22/2022

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	EGAISClient_RU/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	EGAIS counteragents

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Main/EGAISClient_RU
Area		Main/EGAISClient_RU
Building		Main/EGAISClient_RU
City		Main/EGAISClient_RU
Country		Main/EGAISClient_RU
Description		Main/EGAISClient_RU
FullName		Main/EGAISClient_RU
House		Main/EGAISClient_RU
INN		Main/EGAISClient_RU
KPP		Main/EGAISClient_RU
Liter		Main/EGAISClient_RU
Party		Main/EGAISClient_RU
Place		Main/EGAISClient_RU
RegId		Main/EGAISClient_RU
RegionCode		Main/EGAISClient_RU
RNN		Main/EGAISClient_RU
ShortName		Main/EGAISClient_RU
State		Main/EGAISClient_RU
Street		Main/EGAISClient_RU
Type		Main/EGAISClient_RU
UNP		Main/EGAISClient_RU
WaybillVersion		Main/EGAISClient_RU
ZipCode		Main/EGAISClient_RU
DataAreaId		Main/EGAISClient_RU
Relationship_DirPartyTableRelationshipId		Main/EGAISClient_RU
Relationship_CompanyRelationshipId		Main/EGAISClient_RU

RecId

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	EGAISClient_RU/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

Area

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	Area
dataFormat	string
isNullable	true

Traits

List of traits for the Area attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Area

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Building

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	Building
dataFormat	string
isNullable	true

Traits

List of traits for the Building attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Building

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

City

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	City
dataFormat	string
isNullable	true

Traits

List of traits for the City attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	City

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Country

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the Country attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

Description

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the Description attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

FullName

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the FullName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

House

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	House
dataFormat	string
isNullable	true

Traits

List of traits for the House attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	House

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

INN

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the INN attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

KPP

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the KPP attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Liter

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	Letter
dataFormat	string
isNullable	true

Traits

List of traits for the Liter attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Letter

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Party

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	Party
dataFormat	int64
isNullable	true

Traits

List of traits for the Party attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Party

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

Place

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	Place
dataFormat	string
isNullable	true

Traits

List of traits for the Place attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Place

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

RegId

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the RegId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

RegionCode

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the RegionCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

RNN

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the RNN attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ShortName

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ShortName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

State

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the State attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

Street

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	Street
dataFormat	string
isNullable	true

Traits

List of traits for the Street attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Street

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Type

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Type attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

UNP

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the UNP attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

WaybillVersion

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the WaybillVersion attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ZipCode

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
displayName	ZIP code
dataFormat	string
isNullable	true

Traits

List of traits for the ZipCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	ZIP code

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

DataAreaId

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the DataAreaId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array

Relationship_DirPartyTableRelationshipId

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_DirPartyTableRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/operationsCommon/Tables/Common/GAB/Main/DirPartyTable.cdm.json/DirPartyTable	RecId

entity

a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_CompanyRelationshipId

First included in: Main/EGAISClient_RU (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo	RecId

entity

a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Share via

EGAIS counteragents in Main(EGAISClient_RU)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Feedback

Additional resources