Get a Compartment
get
/equipmentGroups/{equipmentGroupGid}/compartments/{compartmentNum}
Request
Path Parameters
-
compartmentNum(required): string
Resource ID
-
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
-
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 : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
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.