Route in Main(TMSRoute)

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	TMSRoute/(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		Main/TMSRoute
ApptUTCDateTime		Main/TMSRoute
CurrencyCode		Main/TMSRoute
DeliveryUTCDateTime		Main/TMSRoute
Description		Main/TMSRoute
InventLocationId		Main/TMSRoute
InventSiteId		Main/TMSRoute
Manual		Main/TMSRoute
Name		Main/TMSRoute
RouteCode		Main/TMSRoute
RouteConfigCode		Main/TMSRoute
RouteGuideRecId		Main/TMSRoute
RoutePlanName		Main/TMSRoute
RouteStatus		Main/TMSRoute
ShipUTCDateTime		Main/TMSRoute
TransportationOrderNum		Main/TMSRoute
RouteSchedule		Main/TMSRoute
MilkrunRoute		Main/TMSRoute
LoadTemplateId		Main/TMSRoute
DataAreaId		Main/TMSRoute
Relationship_CurrencyRelationshipId		Main/TMSRoute
Relationship_InventLocationRelationshipId		Main/TMSRoute
Relationship_InventSiteRelationshipId		Main/TMSRoute
Relationship_TMSRouteConfigRelationshipId		Main/TMSRoute
Relationship_TMSRouteGuideRelationshipId		Main/TMSRoute
Relationship_TMSRouteScheduleRelationshipId		Main/TMSRoute
Relationship_WHSLoadTemplateRelationshipId		Main/TMSRoute
Relationship_CompanyRelationshipId		Main/TMSRoute

RecId

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

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

ApptUTCDateTime

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the ApptUTCDateTime attribute are listed below.

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

is.dataFormat.date

CurrencyCode

First included in: Main/TMSRoute (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

DeliveryUTCDateTime

First included in: Main/TMSRoute (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

Description

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

InventLocationId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

InventSiteId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Manual

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Manual attribute are listed below.

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

is.dataFormat.integer

Name

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
displayName	Route guide
dataFormat	string
isNullable	true

Traits

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

RouteCode

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the RouteCode attribute are listed below.

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

RouteConfigCode

First included in: Main/TMSRoute (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

RouteGuideRecId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the RouteGuideRecId attribute are listed below.

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

is.dataFormat.integer
is.dataFormat.big

RoutePlanName

First included in: Main/TMSRoute (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

RouteStatus

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the RouteStatus attribute are listed below.

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

is.dataFormat.integer

ShipUTCDateTime

First included in: Main/TMSRoute (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

TransportationOrderNum

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

RouteSchedule

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the RouteSchedule attribute are listed below.

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

is.dataFormat.integer
is.dataFormat.big

MilkrunRoute

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MilkrunRoute attribute are listed below.

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

is.dataFormat.integer

LoadTemplateId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DataAreaId

First included in: Main/TMSRoute (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: Main/TMSRoute (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_InventLocationRelationshipId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_InventSiteRelationshipId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_InventSiteRelationshipId 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/Group/InventSite.cdm.json/InventSite 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: Main/TMSRoute (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_TMSRouteGuideRelationshipId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_TMSRouteScheduleRelationshipId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_WHSLoadTemplateRelationshipId

First included in: Main/TMSRoute (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_WHSLoadTemplateRelationshipId 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/Main/WHSLoadTemplate.cdm.json/WHSLoadTemplate 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/TMSRoute (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