Route parameters in Parameter(RouteParameters)

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	RouteParameters/(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 Route parameters	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Parameter/RouteParameters
BlockEditing		Parameter/RouteParameters
BlockRemoveApproval		Parameter/RouteParameters
Key		Parameter/RouteParameters
MandatoryDate		Parameter/RouteParameters
Network		Parameter/RouteParameters
DataAreaId		Parameter/RouteParameters
Relationship_CompanyRelationshipId		Parameter/RouteParameters

RecId

First included in: Parameter/RouteParameters (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	RouteParameters/(resolvedAttributes)/RecId	attribute

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

BlockEditing

First included in: Parameter/RouteParameters (this entity)

Properties

Name	Value
displayName	Block editing
dataFormat	int32
isNullable	true

Traits

List of traits for the BlockEditing attribute are listed below.

is.dataFormat.integer
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 Block editing	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

BlockRemoveApproval

First included in: Parameter/RouteParameters (this entity)

Properties

Name	Value
displayName	Block removal of approval
dataFormat	int32
isNullable	true

Traits

List of traits for the BlockRemoveApproval attribute are listed below.

is.dataFormat.integer
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 Block removal of approval	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Key

First included in: Parameter/RouteParameters (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the Key attribute are listed below.

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

is.dataFormat.integer

MandatoryDate

First included in: Parameter/RouteParameters (this entity)

Properties

Name	Value
displayName	Mandatory date
dataFormat	int32
isNullable	true

Traits

List of traits for the MandatoryDate attribute are listed below.

is.dataFormat.integer
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 Mandatory date	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Network

First included in: Parameter/RouteParameters (this entity)

Properties

Name	Value
displayName	Route network
dataFormat	int32
isNullable	true

Traits

List of traits for the Network attribute are listed below.

is.dataFormat.integer
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 Route network	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DataAreaId

First included in: Parameter/RouteParameters (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_CompanyRelationshipId

First included in: Parameter/RouteParameters (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId 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/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