Jump to

• Request
• Response

Get Equipment Types

get

/equipmentTypes

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

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentTypes

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : equipmentTypes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentDesc: string
  A textual description of the equipment type.
• equipmentDescCode: string
  The equipment description code is a user-defined code for the equipment type description.
• equipmentDescCodeDef: string
  The equipment description code definition is a definition of the equipment type description code.
• equipmentGroups: equipmentGroups
• equipmentTypeGid: string
  The GID for the equipment type. Equipment Types are used to define the characteristics of an equipment group. Using Intermodal Trailers as an example of an equipment group profile, the group in that profile could be 45' or 48' trailers. The equipment type against that group would be either a rollup or swing door trailer.
• equipmentTypeName: string
  Text for the name of the equipment type.
• equipmentTypeXid: string
  The XID for the equipment type.
• exteriorHeight: exteriorHeight
  The height of the exterior of the equipment type.
• exteriorLength: exteriorLength
  The length of the exterior of the equipment type.
• exteriorWidth: exteriorWidth
  The width of the exterior of the equipment type.
• grossWeight: grossWeight
  The equipment type's gross weight.
• insertDate: insertDate
  Read Only: true

  insert date
• interiorHeight: interiorHeight
  The height of the equipment type's interior.
• interiorLength: interiorLength
  The length of the equipment type's interior.
• interiorWidth: interiorWidth
  The width of the equipment type's interior.
• isoEquipmentCode: string
  This is the official International Standards Organization (ISO) code for the container that may be used with this equipment type (EDI element 24). This code identifies the size and type of container in a four-character format. The first and second characters specify the volume of the container, and the third and fourth characters specify the type. This code may or may not be the same as the equipment description code.
• isoEquipmentCodeDef: string
  The ISO equipment code definition is an explanation of the ISO equipment code.
• links: array links
  Read Only: true
• metric3: number (double)
  The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.
• metric4: number (double)
  The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.
• netWeight: netWeight
  The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.
• remarks: remarks
• specialServices: specialServices
• substituteEqTypeProfileGid: string
  Indicates which equipment types can be substituted for this type in fleet equipment planning.
• tag1: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag2: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag3: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag4: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tareWeight: tareWeight
  Weight of the empty equipment type.
• temperatureControl: boolean
  Check box used to enable temperature control functionality to be used for this equipment type.
• temperatureControlGid: string
  A GID to define the temperature controls value for the commodity.
• updateDate: updateDate
  Read Only: true

  update date
• volume: volume
  The volume of the equipment type.

{
    "properties":{
        "equipmentTypeGid":{
            "description":"The GID for the equipment type. Equipment Types are used to define the characteristics of an equipment group. Using Intermodal Trailers as an example of an equipment group profile, the group in that profile could be 45' or 48' trailers. The equipment type against that group would be either a rollup or swing door trailer.",
            "type":"string"
        },
        "equipmentTypeXid":{
            "description":"The XID for the equipment type.",
            "type":"string"
        },
        "equipmentTypeName":{
            "description":"Text for the name of the equipment type.",
            "type":"string"
        },
        "equipmentDesc":{
            "description":"A textual description of the equipment type.",
            "type":"string"
        },
        "equipmentDescCode":{
            "description":"The equipment description code is a user-defined code for the equipment type description.",
            "type":"string"
        },
        "equipmentDescCodeDef":{
            "description":"The equipment description code definition is a definition of the equipment type description code.",
            "type":"string"
        },
        "isoEquipmentCode":{
            "description":"This is the official International Standards Organization (ISO) code for the container that may be used with this equipment type (EDI element 24). This code identifies the size and type of container in a four-character format. The first and second characters specify the volume of the container, and the third and fourth characters specify the type. This code may or may not be the same as the equipment description code.",
            "type":"string"
        },
        "isoEquipmentCodeDef":{
            "description":"The ISO equipment code definition is an explanation of the ISO equipment code.",
            "type":"string"
        },
        "grossWeight":{
            "description":"The equipment type's gross weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of the empty equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "netWeight":{
            "description":"The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "metric3":{
            "description":"The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.",
            "type":"number",
            "format":"double"
        },
        "metric4":{
            "description":"The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.",
            "type":"number",
            "format":"double"
        },
        "interiorLength":{
            "description":"The length of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "interiorWidth":{
            "description":"The width of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "interiorHeight":{
            "description":"The height of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorLength":{
            "description":"The length of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorWidth":{
            "description":"The width of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorHeight":{
            "description":"The height of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "temperatureControl":{
            "description":"Check box used to enable temperature control functionality to be used for this equipment type.",
            "type":"boolean"
        },
        "temperatureControlGid":{
            "description":"A GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "tag1":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag2":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag3":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag4":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "substituteEqTypeProfileGid":{
            "description":"Indicates which equipment types can be substituted for this type in fleet equipment planning.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "equipmentGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.equipmentGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroups

Type: object

Show Source

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

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

Nested Schema : exteriorHeight

The height of the exterior of the equipment type.

Match All

The height of the exterior of the equipment type.

Show Source

• object amountType

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

Nested Schema : exteriorLength

The length of the exterior of the equipment type.

Match All

The length of the exterior of the equipment type.

Show Source

• object amountType

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

Nested Schema : exteriorWidth

The width of the exterior of the equipment type.

Match All

The width of the exterior of the equipment type.

Show Source

• object amountType

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

Nested Schema : grossWeight

The equipment type's gross weight.

Match All

The equipment type's gross weight.

Show Source

• object amountType

{
    "description":"The equipment type's gross weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

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

Nested Schema : interiorHeight

The height of the equipment type's interior.

Match All

The height of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The height of the equipment type's interior.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : interiorLength

The length of the equipment type's interior.

Match All

The length of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The length of the equipment type's interior.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : interiorWidth

The width of the equipment type's interior.

Match All

The width of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The width of the equipment type's interior.",
    "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 : netWeight

The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.

Match All

The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.

Show Source

• object amountType

{
    "description":"The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

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

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

Nested Schema : specialServices

Type: object

Show Source

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

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

Nested Schema : tareWeight

Weight of the empty equipment type.

Match All

Weight of the empty equipment type.

Show Source

• object amountType

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : volume

The volume of the equipment type.

Match All

The volume of the equipment type.

Show Source

• object amountType

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

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentTypes.equipmentGroups

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

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 : equipmentTypes.equipmentGroups

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroupGid: string
  The GID for the equipment group.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group.",
            "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
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

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 : 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 equipmentTypes.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentTypes.remarks"
    }
}

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 : equipmentTypes.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier being entered for the equipment type.
• remarkSequence: number (int64)
  Sequence number for entered remarks.
• remarkText: string
  The remark text being entered for the selected remark qualifier.

{
    "properties":{
        "remarkSequence":{
            "description":"Sequence number for entered remarks.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier being entered for the equipment type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text being entered for the selected remark qualifier.",
            "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
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentTypes.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentTypes.specialServices"
    }
}

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 : equipmentTypes.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this special service for this equipment type.
• expirationDate: expirationDate
  The expiration date of this special service for this equipment type.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special service being entered for the equipment type.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special service being entered for the equipment type.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service for this equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service for this equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this special service for this equipment type.

Match All

The effective date of this special service for this equipment type.

Show Source

• object dateType

{
    "description":"The effective date of this special service for this equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date of this special service for this equipment type.

Match All

The expiration date of this special service for this equipment type.

Show Source

• object dateType

{
    "description":"The expiration date of this special service for this equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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