Route segment for a load in Transaction(TMSRouteSegmentLoad)
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 | TMSRouteSegmentLoad/(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 |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
RecId
First included in: Transaction/TMSRouteSegmentLoad (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 | TMSRouteSegmentLoad/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
AccountNum
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the AccountNum attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
BillOfLadingId
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
displayName | Master bill of lading |
dataFormat | string |
isNullable | true |
Traits
List of traits for the BillOfLadingId 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
BookingNum
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the BookingNum 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
DestinationPostalCode
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the DestinationPostalCode 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
ETA
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the ETA attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
HouseBill
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the HouseBill 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
Id
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the Id attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
InspectionSeal
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the InspectionSeal 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
OrderNum
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the OrderNum attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
OriginPostalCode
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the OriginPostalCode 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
RailUTCDateTime
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the RailUTCDateTime attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
RouteCode
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the RouteCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
SailUTCDateTime
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the SailUTCDateTime attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
Sequence
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
Traits
List of traits for the Sequence attribute are listed below.
is.dataFormat.integer
is.dataFormat.integer
TransportationOrderNum
First included in: Transaction/TMSRouteSegmentLoad (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
VesselName
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the VesselName 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
VoyageNum
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the VoyageNum 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: Transaction/TMSRouteSegmentLoad (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_TMSRouteRelationshipId
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_TMSRouteRelationshipId 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_TMSRouteSegmentRelationshipId
First included in: Transaction/TMSRouteSegmentLoad (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_TMSRouteSegmentRelationshipId 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 |
| 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: Transaction/TMSRouteSegmentLoad (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 |
| 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: Transaction/TMSRouteSegmentLoad (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 |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array