Multimodal dangerous goods table in TransactionHeader(HMIMMultimodalDG)
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 | HMIMMultimodalDG/(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: TransactionHeader/HMIMMultimodalDG (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 | HMIMMultimodalDG/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
MMDGDocumentId
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the MMDGDocumentId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
ShipmentId
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the ShipmentId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
ShippingPostalAddress
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
displayName | Ship from |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the ShippingPostalAddress attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
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.integer
is.dataFormat.big
DeliveryPostalAddress
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
displayName | Delivery address |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the DeliveryPostalAddress attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
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.integer
is.dataFormat.big
CustAccount
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the CustAccount 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
FreightForwarderReference
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the FreightForwarderReference 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
Forwarder
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the Forwarder 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
Movement
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the Movement 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
AdditionalHandlingInfo
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the AdditionalHandlingInfo 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
TransportNumber
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the TransportNumber 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
TransportDate
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the TransportDate attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
LoadingPort
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the LoadingPort 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
DischargePort
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the DischargePort 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
Destination
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the Destination 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
ContainerIdentificationNumber
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ContainerIdentificationNumber 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
SealNum
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
displayName | Seal numbers |
dataFormat | string |
isNullable | true |
Traits
List of traits for the SealNum 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
ContainerInfo
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ContainerInfo 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
ContainerTareWeight
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ContainerTareWeight 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
TotalGrossWeight
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the TotalGrossWeight 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
CompanyName
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the CompanyName 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
ReceivingOrganization
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ReceivingOrganization 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
ShipperPreparation
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the ShipperPreparation 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: TransactionHeader/HMIMMultimodalDG (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: TransactionHeader/HMIMMultimodalDG (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
DataAreaId
First included in: TransactionHeader/HMIMMultimodalDG (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_CustTableRelationshipId
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_CustTableRelationshipId 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_DeliveryLogisticsPostalAddressRelationshipId
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_DeliveryLogisticsPostalAddressRelationshipId 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_ShippingLogisticsPostalAddressRelationshipId
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_ShippingLogisticsPostalAddressRelationshipId 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_WHSShipmentTableRelationshipId
First included in: TransactionHeader/HMIMMultimodalDG (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_WHSShipmentTableRelationshipId 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_TMSCarrierRelationshipId
First included in: TransactionHeader/HMIMMultimodalDG (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 |
| 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: TransactionHeader/HMIMMultimodalDG (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 |
| 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: TransactionHeader/HMIMMultimodalDG (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
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for