Jump to

• Request
• Response

Get Shipment Equipment

get

/sEquipments

Request

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/sEquipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object sEquipments

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : sEquipments

Type: object

Show Source

• actualHeight: actualHeight
  The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.
• actualLength: actualLength
  The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.
• actualLoadLimit: actualLoadLimit
  The maximum permissible weight of the commodity that can be loaded into the equipment.
• actualWidth: actualWidth
  The inside width of the actual equipment from side walls and linings.
• assignmentCode: string
  The assignment code (view only) indicates how the equipment was assigned.
• attributes: attributes
• axleWeightImbalance: number (double)
  Denotes the ratio between the calculated axles weights.Applicable only to rail cars.
• calculatedGrossWt: calculatedGrossWt
  The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight.
• checkDigit: number (int32)
  The Check Digit field is used to validate that the Equipment Initial/Number field is entered correctly. You can leave this field blank if you do not want to validate Equipment Initial/Number. The ISO 6346 for ocean containers is used to verify the check digit value
• domainName: string
  Database domain where this data is stored.
• dropSkuGid: string
  With the DROP_SKU_QUANTITY_TYPE_GID, this identifies the drop-off inventory bucket adjusted during equipment type assignment.
• dropSkuQuantityTypeGid: string
  With the DROP_SKU_QUANTITY_GID this indicates the drop-off inventory bucket adjusted during equipment type assignment.
• dryCapacity: dryCapacity
  The maximum interior capacity of the equipment.
• emptyCgHeight: emptyCgHeight
  When empty, indicates the height from top of rail to the center of gravity.
• emptyCgLength: emptyCgLength
  When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.
• emptyCgWidth: emptyCgWidth
  When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.
• equipMaxGrossWt: equipMaxGrossWt
  The maximum allowed gross weight for the equipment.
• equipmentGid: string
  The GID for the actual equipment asset record.
• equipmentGroupGid: string
  An equipment group identifies the kind of equipment such as dry vans, flatbed trucks, container cars, hoppers, tankers, box cars, etc.. Equipment groups are primarily used by rate offering applied to the cost of moving goods on a class of equipment defined by the equipment group ID.
• equipmentInitial: string
  The initial is a mark that is registered with national or international authorities that is associated with a specific owner.
• equipmentInitialNumber: string
  A concatenation of the equipment initial and equipment number.
• equipmentNumber: string
  Number identifying the equipment used.
• equipmentOwnerType: string
  The asset owner of the equipment.
• equipmentTypeCode: string
  The Equipment Type Code field is used to designate a specific type of equipment and attributes. For information only.
• equipmentTypeGid: string
  An equipment type is a category of equipment. The system uses equipment types when it determines equipment capacity.
• floorHeight: floorHeight
  The actual height of the platform or floor above the ground or the rail.
• freightCgHeight: freightCgHeight
  The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height.
• freightCgLength: freightCgLength
  No description.
• freightCgWidth: freightCgWidth
  No description.
• grossCgHeight: grossCgHeight
  When full, indicates the height from the top of rail to the center of gravity.
• grossCgLength: grossCgLength
  No description.
• grossCgWidth: grossCgWidth
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• intermodalEquipLength: number (int32)
  A specially formatted field that is required by the railroads, representing the length of the equipment. It is in the format FtFtInIn, so 4803 would represent 48 feet, 3 inches.
• isFreight: boolean
  Indicates if the equipment is carrying freight.
• licensePlate: string
  Informational field for identification.
• links: array links
  Read Only: true
• liquidCapacity: liquidCapacity
  The number of gallons the equipment will hold.
• loadConfigVolume: loadConfigVolume
  The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.
• loadingLength: loadingLength
  The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.
• maxAxleWeight: maxAxleWeight
  Maximum allowed axle weight. Applicable only to rail cars.
• mechanicalDesignation: string
  The Mechanical Designation field is an alphabetic code assigned to the physical description of the unit. For information only.
• orEquipmentSeq: number (int32)
  N/A
• pickSkuGid: string
  With PICK_SKU_QUANTITY_TYPE_GID, this identifies the pickup inventory bucket adjusted during equipment type assignment.
• pickSkuQuantityTypeGid: string
  With the PICK_SKU_QUANTITY_GID, this indicates the pickup inventory bucket adjusted during equipment type assignment.
• scaleLocation: string
  Scale location information.
• scaleName: string
  Scale name information.
• scaleTicket: string
  The sequence ID printed on the scale ticket when weight is recorded.
• scaleWeight: scaleWeight
  Weight recorded by scale when the equipment is loaded.
• seals: seals
• sEquipmentGid: string
  The GID for the Equipment associated to a Shipment
• sEquipmentXid: string
  The XID for the equipment associated to a shipment.
• statuses: statuses
• substituteEquipmentGroupGid: string
  The equipment group substituted by carrier for this equipment.
• tareWeight: tareWeight
  Weight of equipment when empty.
• totalAxleCount: number (int32)
  The total number of axles on the equipment. Applicable only to rail cars.
• truckAAxleWeight: truckAAxleWeight
  Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.
• truckAWeight: truckAWeight
  Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.
• truckBAxleWeight: truckBAxleWeight
  Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.
• truckBWeight: truckBWeight
  Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.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.
• typeAssignmentCode: string
  The type assignment code (view only) indicates if the equipment is fixed from the order (equipment type was specified on order) or resource capacity, meaning it came from the resource assignment during the build shipment process.
• updateDate: updateDate
  Read Only: true

  update date
• weightQualifier: string
  Indicates what the scale weight and tare weight fields represent: estimate, net or gross weight.

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the Equipment associated to a Shipment",
            "type":"string"
        },
        "sEquipmentXid":{
            "description":"The XID for the equipment associated to a shipment.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"The initial is a mark that is registered with national or international authorities that is associated with a specific owner.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"Number identifying the equipment used.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"A concatenation of the equipment initial and equipment number.",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"An equipment type is a category of equipment. The system uses equipment types when it determines equipment capacity. ",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"An equipment group identifies the kind of equipment such as dry vans, flatbed trucks, container cars, hoppers, tankers, box cars, etc.. Equipment groups are primarily used by rate offering applied to the cost of moving goods on a class of equipment defined by the equipment group ID. ",
            "type":"string"
        },
        "equipmentGid":{
            "description":"The GID for the actual equipment asset record.",
            "type":"string"
        },
        "weightQualifier":{
            "description":"Indicates what the scale weight and tare weight fields represent: estimate, net or gross weight.",
            "type":"string"
        },
        "scaleWeight":{
            "description":"Weight recorded by scale when the equipment is loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of equipment when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "scaleLocation":{
            "description":"Scale location information.",
            "type":"string"
        },
        "scaleName":{
            "description":"Scale name information.",
            "type":"string"
        },
        "scaleTicket":{
            "description":"The sequence ID printed on the scale ticket when weight is recorded.",
            "type":"string"
        },
        "intermodalEquipLength":{
            "description":"A specially formatted field that is required by the railroads, representing the length of the equipment. It is in the format FtFtInIn, so 4803 would represent 48 feet, 3 inches.",
            "type":"number",
            "format":"int32"
        },
        "substituteEquipmentGroupGid":{
            "description":"The equipment group substituted by carrier for this equipment.",
            "type":"string"
        },
        "loadConfigVolume":{
            "description":"The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "orEquipmentSeq":{
            "description":"N/A",
            "type":"number",
            "format":"int32"
        },
        "loadingLength":{
            "description":"The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "typeAssignmentCode":{
            "description":"The type assignment code (view only) indicates if the equipment is fixed from the order (equipment type was specified on order) or resource capacity, meaning it came from the resource assignment during the build shipment process. ",
            "type":"string"
        },
        "assignmentCode":{
            "description":"The assignment code (view only) indicates how the equipment was assigned.",
            "type":"string"
        },
        "pickSkuGid":{
            "description":"With PICK_SKU_QUANTITY_TYPE_GID, this identifies the pickup inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "pickSkuQuantityTypeGid":{
            "description":"With the PICK_SKU_QUANTITY_GID, this indicates the pickup inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "dropSkuGid":{
            "description":"With the DROP_SKU_QUANTITY_TYPE_GID, this identifies the drop-off inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "dropSkuQuantityTypeGid":{
            "description":"With the  DROP_SKU_QUANTITY_GID this indicates the drop-off inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "isFreight":{
            "description":"Indicates if the equipment is carrying freight.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "checkDigit":{
            "description":"The Check Digit field is used to validate that the Equipment Initial/Number field is entered correctly. You can leave this field blank if you do not want to validate Equipment Initial/Number. The ISO 6346 for ocean containers is used to verify the check digit value ",
            "type":"number",
            "format":"int32"
        },
        "licensePlate":{
            "description":"Informational field for identification.",
            "type":"string"
        },
        "equipmentTypeCode":{
            "description":"The Equipment Type Code field is used to designate a specific type of equipment and attributes. For information only.",
            "type":"string"
        },
        "mechanicalDesignation":{
            "description":"The Mechanical Designation field is an alphabetic code assigned to the physical description of the unit. For information only.",
            "type":"string"
        },
        "equipmentOwnerType":{
            "description":"The asset owner of the equipment.",
            "type":"string"
        },
        "equipMaxGrossWt":{
            "description":"The maximum allowed gross weight for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "floorHeight":{
            "description":"The actual height of the platform or floor above the ground or the rail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgHeight":{
            "description":"When empty, indicates the height from top of rail to the center of gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dryCapacity":{
            "description":"The maximum interior capacity of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "liquidCapacity":{
            "description":"The number of gallons the equipment will hold.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freightCgHeight":{
            "description":"The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "grossCgHeight":{
            "description":"When full, indicates the height from the top of rail to the center of gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "calculatedGrossWt":{
            "description":"The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualLoadLimit":{
            "description":"The maximum permissible weight of the commodity that can be loaded into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualLength":{
            "description":"The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualWidth":{
            "description":"The inside width of the actual equipment from side walls and linings.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualHeight":{
            "description":"The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgLength":{
            "description":"When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgWidth":{
            "description":"When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freightCgLength":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freightCgWidth":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "grossCgLength":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "grossCgWidth":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCenterLength":{
            "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCount":{
            "description":"The total number of trucks/bogies on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "totalAxleCount":{
            "description":"The total number of axles on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "maxAxleWeight":{
            "description":"Maximum allowed axle weight. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckAWeight":{
            "description":"Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckAAxleWeight":{
            "description":"Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckBWeight":{
            "description":"Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckBAxleWeight":{
            "description":"Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "axleWeightImbalance":{
            "description":"Denotes the ratio between the calculated axles weights.Applicable only to rail cars.",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sEquipments.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "attributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sEquipments.attributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sEquipments.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualHeight

The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.

Match All

Show Source

• object amountType

{
    "description":"The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualLength

The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.

Match All

Show Source

• object amountType

{
    "description":"The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualLoadLimit

The maximum permissible weight of the commodity that can be loaded into the equipment.

Match All

Show Source

• object amountType

{
    "description":"The maximum permissible weight of the commodity that can be loaded into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualWidth

The inside width of the actual equipment from side walls and linings.

Match All

Show Source

• object amountType

{
    "description":"The inside width of the actual equipment from side walls and linings.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributes

Type: object

Show Source

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

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

Nested Schema : calculatedGrossWt

The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight.

Match All

Show Source

• object amountType

{
    "description":"The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : dryCapacity

The maximum interior capacity of the equipment.

Match All

Show Source

• object amountType

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

Nested Schema : emptyCgHeight

When empty, indicates the height from top of rail to the center of gravity.

Match All

Show Source

• object amountType

{
    "description":"When empty, indicates the height from top of rail to the center of gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgLength

When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.

Match All

Show Source

• object amountType

{
    "description":"When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgWidth

When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.

Match All

Show Source

• object amountType

{
    "description":"When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipMaxGrossWt

The maximum allowed gross weight for the equipment.

Match All

Show Source

• object amountType

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

Nested Schema : floorHeight

The actual height of the platform or floor above the ground or the rail.

Match All

Show Source

• object amountType

{
    "description":"The actual height of the platform or floor above the ground or the rail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : freightCgHeight

The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height.

Match All

Show Source

• object amountType

{
    "description":"The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : freightCgLength

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : freightCgWidth

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossCgHeight

When full, indicates the height from the top of rail to the center of gravity.

Match All

Show Source

• object amountType

{
    "description":"When full, indicates the height from the top of rail to the center of gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossCgLength

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossCgWidth

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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
}

Nested Schema : liquidCapacity

The number of gallons the equipment will hold.

Match All

Show Source

• object amountType

{
    "description":"The number of gallons the equipment will hold.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : loadConfigVolume

The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.

Match All

Show Source

• object amountType

{
    "description":"The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : loadingLength

The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.

Match All

Show Source

• object amountType

{
    "description":"The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxAxleWeight

Maximum allowed axle weight. Applicable only to rail cars.

Match All

Show Source

• object amountType

{
    "description":"Maximum allowed axle weight. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : scaleWeight

Weight recorded by scale when the equipment is loaded.

Match All

Show Source

• object amountType

{
    "description":"Weight recorded by scale when the equipment is loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : seals

Type: object

Show Source

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

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

Nested Schema : statuses

Type: object

Show Source

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

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

Nested Schema : tareWeight

Weight of equipment when empty.

Match All

Show Source

• object amountType

{
    "description":"Weight of equipment when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckAAxleWeight

Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.

Match All

Show Source

• object amountType

{
    "description":"Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckAWeight

Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.

Match All

Show Source

• object amountType

{
    "description":"Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckBAxleWeight

Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.

Match All

Show Source

• object amountType

{
    "description":"Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckBWeight

Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.

Match All

Show Source

• object amountType

{
    "description":"Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckCenterLength

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Match All

Show Source

• object amountType

{
    "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

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 : items

Type: array

Show Source

• Array of: object sEquipments.attributes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sEquipments.attributes"
    }
}

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 : sEquipments.attributes

Type: object

Show Source

• domainName: string
  No description.
• equipmentAttributeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• equipmentAttributeValue: string
  Value associated with this S_EQUIPMENT for the given Equipment Attribute Qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentAttributeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "equipmentAttributeValue":{
            "description":"Value associated with this S_EQUIPMENT for the given Equipment Attribute Qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object sEquipments.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sEquipments.seals"
    }
}

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 : sEquipments.seals

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• sealNumber: string
  The identification of the seal.
• sealSequence: number (int32)
  Refers to the compartment being sealed.

{
    "properties":{
        "sealSequence":{
            "description":"Refers to the compartment being sealed.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The identification of the seal.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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
}

Nested Schema : items

Type: array

Show Source

• Array of: object sEquipments.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sEquipments.statuses"
    }
}

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 : sEquipments.statuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  No description.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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