Jump to

• Request
• Response

Get Compartments

get

/equipmentGroups/{equipmentGroupGid}/compartments

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.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.compartments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentGroups.compartments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.compartments"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : equipmentGroups.compartments

Type: object

Show Source

• 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.

{
    "properties":{
        "compartmentNum":{
            "description":"Identifies the compartment by number.",
            "type":"number",
            "format":"int32"
        },
        "maxWeight":{
            "description":"The maximum weight for the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"The maximum capacity for the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxMetric3":{
            "description":"N/A",
            "type":"number",
            "format":"double"
        },
        "maxMetric4":{
            "description":"N/A",
            "type":"number",
            "format":"double"
        },
        "length":{
            "description":"The length of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "temperatureControlGid":{
            "description":"The GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "allowCommodityMixing":{
            "description":"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.",
            "type":"boolean"
        },
        "doorHeight":{
            "description":"Defines the height of the door for the compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "curveGid":{
            "description":"The curve function for the roof of the compartment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "startLengthPosition":{
            "description":"Defines the starting position for the compartment length wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startWidthPosition":{
            "description":"Defines the starting position for the compartment, width wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startHeightPosition":{
            "description":"Defines the starting position for the compartment, height wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "compartmentTypeGid":{
            "description":"A GID to define the compartment type.",
            "type":"string"
        },
        "hasMeter":{
            "description":"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).",
            "type":"boolean"
        },
        "commodityGid":{
            "description":"Commodity that is compatible with the compartment.",
            "type":"string"
        },
        "isBulk":{
            "description":"Indicates if it is a BULK. If Y then BULK If N then PACKAGED.",
            "type":"boolean"
        },
        "widthOffset":{
            "description":"Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "lengthFwdOffset":{
            "description":"Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packagedItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.compartments.packagedItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : doorHeight

Defines the height of the door for the compartment.

Match All

Show Source

• object amountType

{
    "description":"Defines the height of the door for the compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : height

The height of the equipment group compartment.

Match All

Show Source

• object amountType

{
    "description":"The height of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length of the equipment group compartment.

Match All

Show Source

• object amountType

{
    "description":"The length of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxVolume

The maximum capacity for the equipment group compartment.

Match All

Show Source

• object amountType

{
    "description":"The maximum capacity for the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

The maximum weight for the equipment group compartment.

Match All

Show Source

• object amountType

{
    "description":"The maximum weight for the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packagedItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.compartments.packagedItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : startHeightPosition

Defines the starting position for the compartment, height wise.

Match All

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment, height wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startLengthPosition

Defines the starting position for the compartment length wise.

Match All

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment length wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startWidthPosition

Defines the starting position for the compartment, width wise.

Match All

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment, width wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of the equipment group compartment.

Match All

Show Source

• object amountType

{
    "description":"The width of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : widthOffset

Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.

Match All

Show Source

• object amountType

{
    "description":"Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentGroups.compartments.packagedItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.compartments.packagedItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : equipmentGroups.compartments.packagedItems

Type: object

Show Source

• 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.

{
    "properties":{
        "packagedItemGid":{
            "description":"The packaged item that is linked to the compartment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top