Create an Equipment Type
post
/equipmentTypes
Request
Header Parameters
-
Prefer:
An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Root Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : equipmentGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exteriorHeight
The height of the exterior of the equipment type.
Match All
Show Source
Nested Schema : exteriorLength
The length of the exterior of the equipment type.
Match All
Show Source
Nested Schema : exteriorWidth
The width of the exterior of the equipment type.
Match All
Show Source
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
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : equipmentTypes.equipmentGroups
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentGroupGid: string
The GID for the equipment group.
-
links: array
links
Read Only:
true
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : equipmentTypes.remarks
Type:
Show Source
object
-
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.
Nested Schema : equipmentTypes.specialServices
Type:
Show Source
object
-
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.
Nested Schema : effectiveDate
The effective date of this special service for this equipment type.
Match All
Show Source
Nested Schema : expirationDate
The expiration date of this special service for this equipment type.
Match All
Show Source
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : equipmentGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exteriorHeight
The height of the exterior of the equipment type.
Match All
Show Source
Nested Schema : exteriorLength
The length of the exterior of the equipment type.
Match All
Show Source
Nested Schema : exteriorWidth
The width of the exterior of the equipment type.
Match All
Show Source
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
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : equipmentTypes.equipmentGroups
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentGroupGid: string
The GID for the equipment group.
-
links: array
links
Read Only:
true
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : equipmentTypes.remarks
Type:
Show Source
object
-
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.
Nested Schema : equipmentTypes.specialServices
Type:
Show Source
object
-
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.
Nested Schema : effectiveDate
The effective date of this special service for this equipment type.
Match All
Show Source
Nested Schema : expirationDate
The expiration date of this special service for this equipment type.
Match All
Show Source