Get an Equipment
get
/equipments/{equipmentGid}
Request
Path Parameters
-
equipmentGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
aarCarType: string
The Association of American Railroads Car Type.
-
aarMechDesig: string
AAR Mechanical Designation.
-
arriveDate:
arriveDate
Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.
-
assignedProduct: string
N/A
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
carDestinationEtaDate:
carDestinationEtaDate
This is the estimated arrival time at the car destination.
-
carDestinationLocationGid: string
Specifies destination for the car.
-
currentChassisInitial: string
Initial of the current chassis.
-
currentChassisNumber: string
Number of the current chassis.
-
customerFleet: string
This is a more granular field for the organization to specify the customer assignment as the customer wishes. It will identify product, location, customer, or any combination.
-
dateBuilt:
dateBuilt
The date this equipment was built.
-
divisionName: string
This is the Business Division name field for part of the organization that is responsible for the asset and the business.
-
documents:
documents
-
domainName: string
Database domain where this data is stored.
-
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, length wise position of center of gravity from the equipment bottom leftmost corner.
-
emptyCgWidth:
emptyCgWidth
When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
-
equipMaxGrossWt:
equipMaxGrossWt
The maximum permissible weight of the equipment and the load.
-
equipmentGid: string
The GID for equipment.
-
equipmentInitial: string
Typically this is a prefix or alphanumeric combination associated with the carrier Standard Carrier Alpha Code (SCAC) for the equipment.
-
equipmentInitialNumber: string
Equipment Initial and Number is a concatenation of the equipment initial and equipment number.
-
equipmentName: string
Text to describe the type of equipment. Examples include: CAR LOADS, TANKER, TRUCKS
-
equipmentNumber: string
The number assigned to the equipment and is entered to associate the number with the equipment initial.
-
equipmentOwnerType: string
The Type of Owner for this Equipment. C = Carrier Owned, L = Lessee, P = Private, A = All
-
equipmentTypeGid: string
The GID for the equipment type.
-
equipmentXid: string
The XID for the equipment type.
-
floorHeight:
floorHeight
Actual height of the platform or floor above the ground or the rail.
-
insertDate:
insertDate
Read Only:
true
insert date -
interchangeRecvDate:
interchangeRecvDate
Time of the interchange receive.
-
interchangeRecvLocationGid: string
Interchange receive location of the equipment.
-
isContainer: boolean
Yes/No indicator for whether the equipment is a container.
-
lastIngateTime:
lastIngateTime
Ingate time stamp at the inbound ramp.
-
lastOutgateLocationGid: string
The location where the equipment (chassis/container or trailer) was last outgated.
-
lastOutgateTime:
lastOutgateTime
Outgate time stamp at the outbound ramp.
-
lesseeGid: string
The SCAC for the Lessee of the Equipment.
-
licensePlate: string
The license plate number.
-
licenseState: string
The license state.
-
links: array
links
Read Only:
true
-
liquidCapacity:
liquidCapacity
The number of gallons the equipment will hold.
-
loadOrEmpty: string
Indicates whether the equipment is Load or Empty or Unknown (default)
-
maxAxleWeight:
maxAxleWeight
Maximum allowed axle weight. Applicable only to rail cars.
-
orderCustomerName: string
This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the consignee.
-
orderDestination: string
This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the city and state.
-
orderSource: string
This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the city and state.
-
ownerName: string
Text for the name of the equipment owner.
-
ownershipCode: string
Alpha-numeric code designating the status of the equipment (for example, leased or owned).
-
parkLocationGid: string
Park location of the equipment.
-
prevReportingRrScac: string
This is the previous Reporting SCAC. The UPDATE ACTION moves the current value to the previous value before overwriting the current value.
-
prevSightingDate:
prevSightingDate
Time of the previous sighting.
-
prevSightingEvtScGid: string
Previous sighting event represents the previous status code of the equipment.
-
prevSightingLocationGid: string
Previous sighting location of the equipment.
-
purchDate:
purchDate
The purchase date of this equipment.
-
refnums:
refnums
-
registrationDate:
registrationDate
The date of the registration.
-
registrationNum: string
Registration number.
-
releaseDate:
releaseDate
Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.
-
remarks:
remarks
-
reportingRrScac: string
This is to report the Railroad Reporting SCAC code that provided the last event. It is copied in an agent action called UPDATE SIGHTING.
-
sightingDate:
sightingDate
Time of the sighting.
-
sightingEvtScGid: string
Sighting event represents the current status code of the equipment.
-
sightingLocationGid: string
Sighting location of the equipment.
-
specialServices:
specialServices
-
statuses:
statuses
-
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
The empty weight of the equipment by itself.
-
texts:
texts
-
totalAxleCount: number
(int32)
The total number of axles on the equipment. Applicable only to rail cars.
-
trackingEvents:
trackingEvents
-
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.
-
umCharge:
umCharge
UMLER Mileage Charge.
-
umChargeUnit:
umChargeUnit
UMLER Mileage Charge Unit (example, 2).
-
updateDate:
updateDate
Read Only:
true
update date -
userDefined1IconGid: string
The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined2IconGid: string
The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined3IconGid: string
The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined4IconGid: string
The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined5IconGid: string
The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
Nested Schema : arriveDate
Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : carDestinationEtaDate
This is the estimated arrival time at the car destination.
Match All
Show Source
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : emptyCgHeight
When empty, indicates the height from Top of Rail to the Center of Gravity.
Match All
Show Source
Nested Schema : emptyCgLength
When empty, length wise position of center of gravity from the equipment bottom leftmost corner.
Match All
Show Source
Nested Schema : emptyCgWidth
When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
Match All
Show Source
Nested Schema : equipMaxGrossWt
The maximum permissible weight of the equipment and the load.
Match All
Show Source
Nested Schema : floorHeight
Actual height of the platform or floor above the ground or the rail.
Match All
Show Source
Nested Schema : maxAxleWeight
Maximum allowed axle weight. Applicable only to rail cars.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : releaseDate
Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.
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 : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : trackingEvents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : truckCenterLength
The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
Match All
Show Source
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : equipments.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : equipments.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentRefnumQualGid: string
The equipment reference number qualifier.
-
links: array
links
Read Only:
true
-
refnumValue: string
The equipment reference number value.
Nested Schema : equipments.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The Remark Qualifier ID.
-
remarkSequence: number
(int64)
The sequence number of the remark.
-
remarkText: string
The Text of the Remark.
Nested Schema : equipments.specialServices
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
effectiveDate:
effectiveDate
The effective date of this special service.
-
expirationDate:
expirationDate
The expiration date of this special service.
-
links: array
links
Read Only:
true
-
specialServiceGid: string
The GID for the special services being assigned to the equipment.
Nested Schema : equipments.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
Status type for the equipment status.
-
statusValueGid: string
Value of status type
Nested Schema : equipments.texts
Type:
Show Source
object
-
documentDefGid: string
The GID of the document that should hold the text.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
textOverride: string
Transactional override for the template on the specific document.
-
textTemplateGid: string
The GID for the text template related to equipment, The selected template is used with the text override option to populate the remark text.
Nested Schema : equipments.trackingEvents
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
iTransactionNo: number
(int64)
The transaction identifier linked to the equipment.
-
links: array
links
Read Only:
true
-
partitionKey: number
(double)
The monthly range partition to manage purging status messages.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency