Route in WorksheetLine(TMSRouteTable)

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

Attributes

Name	Description	First Included in Instance
RecId		WorksheetLine/TMSRouteTable
Action		WorksheetLine/TMSRouteTable
CarrierCode		WorksheetLine/TMSRouteTable
CarrierServiceCode		WorksheetLine/TMSRouteTable
CurrencyCode		WorksheetLine/TMSRouteTable
CustomerRate		WorksheetLine/TMSRouteTable
DeliveryUTCDateTime		WorksheetLine/TMSRouteTable
HasErrors		WorksheetLine/TMSRouteTable
Id		WorksheetLine/TMSRouteTable
ModeCode		WorksheetLine/TMSRouteTable
RefRecId		WorksheetLine/TMSRouteTable
RefTableId		WorksheetLine/TMSRouteTable
RouteConfigCode		WorksheetLine/TMSRouteTable
RouteGuideName		WorksheetLine/TMSRouteTable
RouteId		WorksheetLine/TMSRouteTable
RoutePlanName		WorksheetLine/TMSRouteTable
ShipperRate		WorksheetLine/TMSRouteTable
ShipUTCDateTime		WorksheetLine/TMSRouteTable
TotalRate		WorksheetLine/TMSRouteTable
IsScheduledRoute		WorksheetLine/TMSRouteTable
DataAreaId		WorksheetLine/TMSRouteTable
Relationship_CurrencyRelationshipId		WorksheetLine/TMSRouteTable
Relationship_PurchTableRelationshipId		WorksheetLine/TMSRouteTable
Relationship_SalesTableRelationshipId		WorksheetLine/TMSRouteTable
Relationship_TMSCarrierRelationshipId		WorksheetLine/TMSRouteTable
Relationship_TMSCarrierServiceRelationshipId		WorksheetLine/TMSRouteTable
Relationship_TMSModeRelationshipId		WorksheetLine/TMSRouteTable
Relationship_TMSRateRouteAddressRelationshipId		WorksheetLine/TMSRouteTable
Relationship_TMSRouteConfigRelationshipId		WorksheetLine/TMSRouteTable
Relationship_WHSContainerTableRelationshipId		WorksheetLine/TMSRouteTable
Relationship_WHSLoadTableRelationshipId		WorksheetLine/TMSRouteTable
Relationship_CompanyRelationshipId		WorksheetLine/TMSRouteTable

RecId

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

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

Action

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Action attribute are listed below.

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

is.dataFormat.integer

CarrierCode

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CarrierServiceCode

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CurrencyCode

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the CurrencyCode attribute are listed below.

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

CustomerRate

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	decimal
isNullable	true

Traits

List of traits for the CustomerRate attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

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

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

DeliveryUTCDateTime

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the DeliveryUTCDateTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

HasErrors

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the HasErrors attribute are listed below.

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

is.dataFormat.integer

Id

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ModeCode

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

RefRecId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the RefRecId attribute are listed below.

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

RefTableId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the RefTableId attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

RouteConfigCode

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

RouteGuideName

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
displayName	Route guide
dataFormat	string
isNullable	true

Traits

List of traits for the RouteGuideName 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 Route guide	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

RouteId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the RouteId attribute are listed below.

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

RoutePlanName

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
displayName	Route plan
dataFormat	string
isNullable	true

Traits

List of traits for the RoutePlanName 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 Route plan	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ShipperRate

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	decimal
isNullable	true

Traits

List of traits for the ShipperRate attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

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

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ShipUTCDateTime

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the ShipUTCDateTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

TotalRate

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
displayName	Total rate
dataFormat	decimal
isNullable	true

Traits

List of traits for the TotalRate attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

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 Total rate	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

IsScheduledRoute

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the IsScheduledRoute attribute are listed below.

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

is.dataFormat.integer

DataAreaId

First included in: WorksheetLine/TMSRouteTable (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_CurrencyRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CurrencyRelationshipId 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/Currency/Group/Currency.cdm.json/Currency RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_PurchTableRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_PurchTableRelationshipId 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/SupplyChain/ProcurementAndSourcing/WorksheetHeader/PurchTable.cdm.json/PurchTable RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_SalesTableRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_SalesTableRelationshipId 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/SupplyChain/SalesAndMarketing/WorksheetHeader/SalesTable.cdm.json/SalesTable RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_TMSCarrierRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSCarrierRelationshipId 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/SupplyChain/Transportation/Main/TMSCarrier.cdm.json/TMSCarrier RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_TMSCarrierServiceRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSCarrierServiceRelationshipId 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/SupplyChain/Transportation/Group/TMSCarrierService.cdm.json/TMSCarrierService RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_TMSModeRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSModeRelationshipId 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/SupplyChain/Transportation/Group/TMSMode.cdm.json/TMSMode RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_TMSRateRouteAddressRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSRateRouteAddressRelationshipId 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/SupplyChain/Transportation/Group/TMSRateRouteAddress.cdm.json/TMSRateRouteAddress RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_TMSRouteConfigRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSRouteConfigRelationshipId 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/SupplyChain/Transportation/Group/TMSRouteConfig.cdm.json/TMSRouteConfig RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_WHSContainerTableRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_WHSContainerTableRelationshipId 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/SupplyChain/Inventory/Transaction/WHSContainerTable.cdm.json/WHSContainerTable RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_WHSLoadTableRelationshipId

First included in: WorksheetLine/TMSRouteTable (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_WHSLoadTableRelationshipId 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/SupplyChain/Inventory/WorksheetHeader/WHSLoadTable.cdm.json/WHSLoadTable 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: WorksheetLine/TMSRouteTable (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