Route segment configuration in Group(TMSRouteSegmentConfig)

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

Attributes

Name	Description	First Included in Instance
RecId		Group/TMSRouteSegmentConfig
RouteStartHubCode		Group/TMSRouteSegmentConfig
CarrierCode		Group/TMSRouteSegmentConfig
CarrierGroupCode		Group/TMSRouteSegmentConfig
CarrierServiceCode		Group/TMSRouteSegmentConfig
FreightTermCode		Group/TMSRouteSegmentConfig
InvoiceAccountType		Group/TMSRouteSegmentConfig
ModeCode		Group/TMSRouteSegmentConfig
Name		Group/TMSRouteSegmentConfig
ResponsibleForPayment		Group/TMSRouteSegmentConfig
RouteConfigCode		Group/TMSRouteSegmentConfig
RouteEndHubCode		Group/TMSRouteSegmentConfig
Sequence		Group/TMSRouteSegmentConfig
VendorCode		Group/TMSRouteSegmentConfig
VendorInvoiceCode		Group/TMSRouteSegmentConfig
DataAreaId		Group/TMSRouteSegmentConfig
Relationship_DlvTermRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSCarrierRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSCarrierGroupRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSCarrierServiceRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSHubMasterEndRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSHubMasterStartRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSModeRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSRouteConfigRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSRouteEndHubConfigRelationshipId		Group/TMSRouteSegmentConfig
Relationship_TMSRouteStartHubConfigRelationshipId		Group/TMSRouteSegmentConfig
Relationship_VendTableRelationshipId		Group/TMSRouteSegmentConfig
Relationship_VendTableInvoiceRelationshipId		Group/TMSRouteSegmentConfig
Relationship_CompanyRelationshipId		Group/TMSRouteSegmentConfig

RecId

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

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

RouteStartHubCode

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CarrierCode

First included in: Group/TMSRouteSegmentConfig (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

CarrierGroupCode

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the CarrierGroupCode 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: Group/TMSRouteSegmentConfig (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

FreightTermCode

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

InvoiceAccountType

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the InvoiceAccountType attribute are listed below.

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

is.dataFormat.integer

ModeCode

First included in: Group/TMSRouteSegmentConfig (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

Name

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
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.dataFormat.character
is.dataFormat.array

ResponsibleForPayment

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ResponsibleForPayment attribute are listed below.

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

is.dataFormat.integer

RouteConfigCode

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the RouteConfigCode attribute are listed below.

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

RouteEndHubCode

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Sequence

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the Sequence attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

VendorCode

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorInvoiceCode

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the VendorInvoiceCode 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: Group/TMSRouteSegmentConfig (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_DlvTermRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_DlvTermRelationshipId 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/Group/DlvTerm.cdm.json/DlvTerm 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: Group/TMSRouteSegmentConfig (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_TMSCarrierGroupRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSCarrierGroupRelationshipId 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/TMSCarrierGroup.cdm.json/TMSCarrierGroup 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: Group/TMSRouteSegmentConfig (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_TMSHubMasterEndRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_TMSHubMasterStartRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSHubMasterStartRelationshipId 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/TMSHubMaster.cdm.json/TMSHubMaster 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: Group/TMSRouteSegmentConfig (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_TMSRouteConfigRelationshipId

First included in: Group/TMSRouteSegmentConfig (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_TMSRouteEndHubConfigRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_TMSRouteStartHubConfigRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_VendTableRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_VendTableInvoiceRelationshipId

First included in: Group/TMSRouteSegmentConfig (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_VendTableInvoiceRelationshipId 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/Vendor/Main/VendTable.cdm.json/VendTable 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: Group/TMSRouteSegmentConfig (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