Get an Equipment Group
get
/equipmentGroups/{equipmentGroupGid}
Request
Path Parameters
-
equipmentGroupGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
allowLifoOnly: boolean
Indicates whether the equipment is for LIFO only.
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
axleLoadingWeights:
axleLoadingWeights
-
combEquipGrpStructSeq: number
(int32)
If the equipment group is a composite equipment group, it will have this comb_equip_grp_struct_seq populated. It contains the list of equipment groups that belong to a double or triple.
-
commodityGid: string
The commodity that is compatible with the equipment group.
-
compartments:
compartments
-
compartmentTypeGid: string
A GID to define the compartment type.
-
curveGid: string
Defined the curve function of the curved roof of the equipment group.
-
domainName: string
Database domain where this data is stored.
-
doorHeight:
doorHeight
Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.
-
effectiveVolume:
effectiveVolume
The capacity for the equipment.
-
effectiveWeight:
effectiveWeight
The weight of the equipment.
-
emptyCgHeight:
emptyCgHeight
When empty, indicates the height from Top of Rail to the Center of Gravity.
-
emptyCgLength:
emptyCgLength
When empty, length wise position of center of gravity from the equipment bottom leftmost corner.
-
emptyCgWidth:
emptyCgWidth
When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
-
equipMaxGrossWt:
equipMaxGrossWt
The maximum permissible weight of the equipment and the load.
-
equipmentGroupGid: string
The GID for the equipment group.
-
equipmentGroupName: string
Describes the group of equipment.
-
equipmentGroupXid: string
The XID for the equipment group.
-
equipmentOwnerType: string
The type of company that owns the stenciled mark on the equipment. For example private or carrier.
-
equipmentRefUnits:
equipmentRefUnits
-
equipmentTypeCode: string
Alphanumeric code used to designate a specific type of equipment and attributes.
-
equipmentTypes:
equipmentTypes
-
exteriorHeight:
exteriorHeight
Stores the exterior height of the equipment group.
-
exteriorLength:
exteriorLength
Stores the exterior length of the equipment group.
-
exteriorWidth:
exteriorWidth
Stores the width length of the equipment group.
-
feuEquivalentCount: number
(double)
The forty foot unit equivalent count for this equipment group.
-
floorHeight:
floorHeight
Actual height of the platform or floor above the ground or the rail.
-
hasMeter: boolean
Indicates if the compartment has METER or not. (The METER is a device that is used the measure how much product is discharged at any given stop).
-
height:
height
The height of the equipment group.
-
insertDate:
insertDate
Read Only:
true
insert date -
isBulk: boolean
Indicates if it is a BULK. If Y then BULK If N then PACKAGED.
-
isContainer: boolean
The is container check box to identifies container equipment groups. Equipment groups with this check box marked are considered during the unitization process that can occur when running the Build Buy Shipment on Primary Leg action for an order release.
-
length:
length
The length of the equipment group.
-
links: array
links
Read Only:
true
-
maxAxleWeight:
maxAxleWeight
Maximum allowed axle weight. Applicable only to rail cars.
-
maxHeightPerUnit:
maxHeightPerUnit
Stores the maximum per ship unit height allowed.
-
maxLengthPerUnit:
maxLengthPerUnit
Stores the maximum per ship unit length allowed.
-
maxLhsWeight:
maxLhsWeight
The max weight allowed on the left hand side of the equipment.
-
maxRhsWeight:
maxRhsWeight
The max weight allowed on the right hand side of the equipment.
-
maxSideWeightDiff:
maxSideWeightDiff
The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.
-
maxWidthPerUnit:
maxWidthPerUnit
Stores the maximum per ship unit width allowed.
-
mechanicalDesignation: string
Alphabetic code assigned to the physical description of the unit.
-
obstructions:
obstructions
-
packagedItems:
packagedItems
-
pullingLength:
pullingLength
Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.
-
shipUnitSpecCompatibilities:
shipUnitSpecCompatibilities
-
tareWeight:
tareWeight
The tare weight of the equipment group.
-
temperatureControlGid: string
A GID to define the temperature controls value for the commodity.
-
teuEquivalentCount: number
(double)
The twenty foot unit equivalent count for this equipment group.
-
totalAxleCount: number
(int32)
The total number of axles on the equipment. Applicable only to rail cars.
-
truckCenterLength:
truckCenterLength
The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
-
truckCount: number
(int32)
The total number of trucks/bogies on the equipment. Applicable only to rail cars.
-
truckTypeGid: string
An GID to define the Truck Type to Categorize the Equipment Group.
-
updateDate:
updateDate
Read Only:
true
update date -
vehicleTypeCompatibilities:
vehicleTypeCompatibilities
-
width:
width
The width of the equipment group.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : axleLoadingWeights
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : compartments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : doorHeight
Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.
Match All
Show Source
Nested Schema : emptyCgHeight
When empty, indicates the height from Top of Rail to the Center of Gravity.
Match All
Show Source
Nested Schema : emptyCgLength
When empty, length wise position of center of gravity from the equipment bottom leftmost corner.
Match All
Show Source
Nested Schema : emptyCgWidth
When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
Match All
Show Source
Nested Schema : equipMaxGrossWt
The maximum permissible weight of the equipment and the load.
Match All
Show Source
Nested Schema : equipmentRefUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : equipmentTypes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exteriorHeight
Stores the exterior height of the equipment group.
Match All
Show Source
Nested Schema : exteriorLength
Stores the exterior length of the equipment group.
Match All
Show Source
Nested Schema : floorHeight
Actual height of the platform or floor above the ground or the rail.
Match All
Show Source
Nested Schema : maxAxleWeight
Maximum allowed axle weight. Applicable only to rail cars.
Match All
Show Source
Nested Schema : maxHeightPerUnit
Stores the maximum per ship unit height allowed.
Match All
Show Source
Nested Schema : maxLengthPerUnit
Stores the maximum per ship unit length allowed.
Match All
Show Source
Nested Schema : maxLhsWeight
The max weight allowed on the left hand side of the equipment.
Match All
Show Source
Nested Schema : maxRhsWeight
The max weight allowed on the right hand side of the equipment.
Match All
Show Source
Nested Schema : maxSideWeightDiff
The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.
Match All
Show Source
Nested Schema : maxWidthPerUnit
Stores the maximum per ship unit width allowed.
Match All
Show Source
Nested Schema : obstructions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : packagedItems
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : pullingLength
Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.
Match All
Show Source
Nested Schema : shipUnitSpecCompatibilities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : truckCenterLength
The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
Match All
Show Source
Nested Schema : vehicleTypeCompatibilities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : equipmentGroups.axleLoadingWeights
Type:
Show Source
object
-
axleDistance:
axleDistance
The distance from the nose of the equipment where the max weight can be loaded.
-
axleName: string
User-specified name for the axle where the distance and max weight are defined, such as front axle or rear axle.
-
axleSequenceNo: number
(int32)
The axle sequence number.
-
domainName: string
Axle distance in the base unit of measure.
-
links: array
links
Read Only:
true
-
maxWeight:
maxWeight
The max loading weight allowed.
Nested Schema : axleDistance
The distance from the nose of the equipment where the max weight can be loaded.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : equipmentGroups.compartments
Type:
Show Source
object
-
allowCommodityMixing: boolean
Specifies if different commodity items can be shipped in the same compartment in an equipment group. Valid values are Y for yes and N for no.
-
commodityGid: string
Commodity that is compatible with the compartment.
-
compartmentNum: number
(int32)
Identifies the compartment by number.
-
compartmentTypeGid: string
A GID to define the compartment type.
-
curveGid: string
The curve function for the roof of the compartment.
-
domainName: string
Database domain where this data is stored.
-
doorHeight:
doorHeight
Defines the height of the door for the compartment.
-
hasMeter: boolean
Indicates if the compartment has METER or not (The METER is a device that is used the measure how much product is discharged at any given stop).
-
height:
height
The height of the equipment group compartment.
-
isBulk: boolean
Indicates if it is a BULK. If Y then BULK If N then PACKAGED.
-
length:
length
The length of the equipment group compartment.
-
lengthFwdOffset:
lengthFwdOffset
Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.
-
links: array
links
Read Only:
true
-
maxMetric3: number
(double)
N/A
-
maxMetric4: number
(double)
N/A
-
maxVolume:
maxVolume
The maximum capacity for the equipment group compartment.
-
maxWeight:
maxWeight
The maximum weight for the equipment group compartment.
-
packagedItems:
packagedItems
-
startHeightPosition:
startHeightPosition
Defines the starting position for the compartment, height wise.
-
startLengthPosition:
startLengthPosition
Defines the starting position for the compartment length wise.
-
startWidthPosition:
startWidthPosition
Defines the starting position for the compartment, width wise.
-
temperatureControlGid: string
The GID to define the temperature controls value for the commodity.
-
width:
width
The width of the equipment group compartment.
-
widthOffset:
widthOffset
Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.
Nested Schema : doorHeight
Defines the height of the door for the compartment.
Match All
Show Source
Nested Schema : lengthFwdOffset
Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.
Match All
Show Source
Nested Schema : maxVolume
The maximum capacity for the equipment group compartment.
Match All
Show Source
Nested Schema : maxWeight
The maximum weight for the equipment group compartment.
Match All
Show Source
Nested Schema : packagedItems
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : startHeightPosition
Defines the starting position for the compartment, height wise.
Match All
Show Source
Nested Schema : startLengthPosition
Defines the starting position for the compartment length wise.
Match All
Show Source
Nested Schema : startWidthPosition
Defines the starting position for the compartment, width wise.
Match All
Show Source
Nested Schema : widthOffset
Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.
Match All
Show Source
Nested Schema : equipmentGroups.compartments.packagedItems
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
packagedItemGid: string
The packaged item that is linked to the compartment.
Nested Schema : equipmentGroups.equipmentRefUnits
Type:
Show Source
object
-
compartmentNum: number
(int32)
The equipment compartment number for which the ERU capacity is being defined.
-
domainName: string
Database domain where this data is stored.
-
equipmentReferenceUnitGid: string
The GID for the equipment group reference unit being defined.
-
limitNumReferenceUnits: number
(double)
Limit for the number of ERUs. The limit allows you to set an artificial limit to allow the placement of up to a certain number of ERUs and then allows the equipment to be filled with other ERUs.
-
links: array
links
Read Only:
true
-
numReferenceUnits: number
(double)
The maximum number of ERUs that can be held in the compartment.
Nested Schema : equipmentGroups.equipmentTypes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentTypeGid: string
The GID for the equipment type.
-
links: array
links
Read Only:
true
Nested Schema : equipmentGroups.obstructions
Type:
Show Source
object
-
compartmentNum: number
(int32)
The equipment compartment number for which the obstruction is being defined.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obstrHeight:
obstrHeight
The height coordinate for the obstruction.
-
obstrLength:
obstrLength
The length of the obstruction.
-
obstructionName: string
Name given to obstruction.
-
obstructionNum: number
(int32)
Number identifier for the obstruction.
-
obstrWidth:
obstrWidth
The width of the obstruction.
-
startHeightPosition:
startHeightPosition
The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
-
startLengthPosition:
startLengthPosition
The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
-
startWidthPosition:
startWidthPosition
The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Nested Schema : startHeightPosition
The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Match All
Show Source
Nested Schema : startLengthPosition
The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Match All
Show Source
Nested Schema : startWidthPosition
The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Match All
Show Source
Nested Schema : equipmentGroups.packagedItems
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
packagedItemGid: string
The packaged item that is linked to the equipment group.
Nested Schema : equipmentGroups.shipUnitSpecCompatibilities
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
transportHandlingUnitGid: string
The GID for the transport handling unit.
Nested Schema : equipmentGroups.vehicleTypeCompatibilities
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
vehicleTypeGid: string
The GID for the vehicle type. Vehicle type generally refers to the type of equipment (aircraft) that will be linked to an air schedule. Vehicle types contain door height and width dimensions that must be added to the equipment group so that ship units assigned to that equipment group can fit through the door when they are loaded onto the plane. For example, you can create a ship unit with dimensions of 10 feet in height by 10 feet in width. You can then assign that ship unit to an equipment group. If you create a vehicle type and assign it to that equipment group, then the vehicle type's door dimensions must be larger than those of the ship unit (for example, 20 feet in height and 20 feet in width).
If these door dimensions are not larger than the ship unit dimensions and the equipment group is assigned to a shipment, shipment planning produces an infeasible shipment with this equipment group.
If you setup your vehicle types without any equipment groups, the system will check the ship unit against door dimensions on the vehicle type "loose freight" scenario.
If you make an association between the vehicle type and an equipment group, then the system no longer does the door dimension check, but does a check to see if the equipment group assigned to the shipment is compatible with the equipment group(s) associated with the vehicle type.