Jump to

• Request
• Response

Get Equipment

get

/equipments

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

Nested Schema : items

Type: array

Show Source

• Array of: object equipments

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : equipments

Type: object

Show Source

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

{
    "properties":{
        "equipmentGid":{
            "description":"The GID for equipment.",
            "type":"string"
        },
        "equipmentXid":{
            "description":"The XID for the equipment type.",
            "type":"string"
        },
        "equipmentName":{
            "description":"Text to describe the type of equipment. Examples include: CAR LOADS, TANKER, TRUCKS",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"The GID for the equipment type.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"Typically this is a prefix or alphanumeric combination associated with the carrier Standard Carrier Alpha Code (SCAC) for the equipment.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The number assigned to the equipment and is entered to associate the number with the equipment initial.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"Equipment Initial and Number is a concatenation of the equipment initial and equipment number. ",
            "type":"string"
        },
        "ownershipCode":{
            "description":"Alpha-numeric code designating the status of the equipment (for example, leased or owned).",
            "type":"string"
        },
        "ownerName":{
            "description":"Text for the name of the equipment owner.",
            "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"
        },
        "equipmentOwnerType":{
            "description":"The Type of Owner for this Equipment. C = Carrier Owned, L = Lessee, P = Private, A = All",
            "type":"string"
        },
        "lesseeGid":{
            "description":"The SCAC for the Lessee of the Equipment.",
            "type":"string"
        },
        "tareWeight":{
            "description":"The empty weight of the equipment by itself.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aarCarType":{
            "description":"The Association of American Railroads Car Type.",
            "type":"string"
        },
        "dateBuilt":{
            "description":"The date this equipment was built.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "purchDate":{
            "description":"The purchase date of this equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "registrationNum":{
            "description":"Registration number.",
            "type":"string"
        },
        "registrationDate":{
            "description":"The date of the registration.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "licensePlate":{
            "description":"The license plate number.",
            "type":"string"
        },
        "licenseState":{
            "description":"The license state.",
            "type":"string"
        },
        "sightingLocationGid":{
            "description":"Sighting location of the equipment.",
            "type":"string"
        },
        "sightingDate":{
            "description":"Time of the sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevSightingLocationGid":{
            "description":"Previous sighting location of the equipment.",
            "type":"string"
        },
        "prevSightingDate":{
            "description":"Time of the previous sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "interchangeRecvLocationGid":{
            "description":"Interchange receive location of the equipment.",
            "type":"string"
        },
        "interchangeRecvDate":{
            "description":"Time of the interchange receive.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"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.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"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.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"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.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"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.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"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.",
            "type":"string"
        },
        "isContainer":{
            "description":"Yes/No indicator for whether the equipment is a container.",
            "type":"boolean"
        },
        "currentChassisInitial":{
            "description":"Initial of the current chassis.",
            "type":"string"
        },
        "currentChassisNumber":{
            "description":"Number of the current chassis.",
            "type":"string"
        },
        "lastOutgateLocationGid":{
            "description":"The location where the equipment (chassis/container or trailer) was last outgated.",
            "type":"string"
        },
        "lastOutgateTime":{
            "description":"Outgate time stamp at the outbound ramp.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastIngateTime":{
            "description":"Ingate time stamp at the inbound ramp.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "parkLocationGid":{
            "description":"Park location of the equipment.",
            "type":"string"
        },
        "umCharge":{
            "description":"UMLER Mileage Charge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "umChargeUnit":{
            "description":"UMLER Mileage Charge Unit (example, 2).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aarMechDesig":{
            "description":"AAR Mechanical Designation.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "equipMaxGrossWt":{
            "description":"The maximum permissible weight of the equipment and the load.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "floorHeight":{
            "description":"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"
                }
            ]
        },
        "assignedProduct":{
            "description":"N/A",
            "type":"string"
        },
        "carDestinationLocationGid":{
            "description":"Specifies destination for the car.",
            "type":"string"
        },
        "carDestinationEtaDate":{
            "description":"This is the estimated arrival time at the car destination.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "emptyCgLength":{
            "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgWidth":{
            "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadOrEmpty":{
            "description":"Indicates whether the equipment is Load or Empty or Unknown (default)",
            "type":"string"
        },
        "sightingEvtScGid":{
            "description":"Sighting event represents the current status code of the equipment.",
            "type":"string"
        },
        "prevSightingEvtScGid":{
            "description":"Previous sighting event represents the previous status code of the equipment.",
            "type":"string"
        },
        "divisionName":{
            "description":"This is the Business Division name field for part of the organization that is responsible for the asset and the business.",
            "type":"string"
        },
        "customerFleet":{
            "description":"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.",
            "type":"string"
        },
        "reportingRrScac":{
            "description":"This is to report the Railroad Reporting SCAC code that provided the last event. It is copied in an agent action called UPDATE SIGHTING.",
            "type":"string"
        },
        "prevReportingRrScac":{
            "description":"This is the previous Reporting SCAC.  The UPDATE ACTION moves the current value to the previous value before overwriting the current value.",
            "type":"string"
        },
        "releaseDate":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "arriveDate":{
            "description":"Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "orderSource":{
            "description":"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.",
            "type":"string"
        },
        "orderDestination":{
            "description":"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.",
            "type":"string"
        },
        "orderCustomerName":{
            "description":"This is a customer determined field based on an agent action.  Most likely the customer will populate an abbreviated version of the consignee.",
            "type":"string"
        },
        "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"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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

• object dateTimeType

{
    "description":"Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : carDestinationEtaDate

This is the estimated arrival time at the car destination.

Match All

Show Source

• object dateTimeType

{
    "description":"This is the estimated arrival time at the car destination.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dateBuilt

The date this equipment was built.

Match All

Show Source

• object dateType

{
    "description":"The date this equipment was built.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

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

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

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, length wise position of center of gravity from the equipment bottom leftmost corner.

Match All

Show Source

• object amountType

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

Nested Schema : emptyCgWidth

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

Match All

Show Source

• object amountType

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

Nested Schema : equipMaxGrossWt

The maximum permissible weight of the equipment and the load.

Match All

Show Source

• object amountType

{
    "description":"The maximum permissible weight of the equipment and the load.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : floorHeight

Actual height of the platform or floor above the ground or the rail.

Match All

Show Source

• object amountType

{
    "description":"Actual height of the platform or floor above the ground or the rail.",
    "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 : interchangeRecvDate

Time of the interchange receive.

Match All

Show Source

• object dateTimeType

{
    "description":"Time of the interchange receive.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lastIngateTime

Ingate time stamp at the inbound ramp.

Match All

Show Source

• object dateTimeType

{
    "description":"Ingate time stamp at the inbound ramp.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lastOutgateTime

Outgate time stamp at the outbound ramp.

Match All

Show Source

• object dateTimeType

{
    "description":"Outgate time stamp at the outbound ramp.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Time of the previous sighting.

Match All

Show Source

• object dateTimeType

{
    "description":"Time of the previous sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : purchDate

The purchase date of this equipment.

Match All

Show Source

• object dateType

{
    "description":"The purchase date of this equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

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

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

Nested Schema : registrationDate

The date of the registration.

Match All

Show Source

• object dateType

{
    "description":"The date of the registration.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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

• object dateTimeType

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

Nested Schema : remarks

Type: object

Show Source

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

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

Nested Schema : sightingDate

Time of the sighting.

Match All

Show Source

• object dateTimeType

{
    "description":"Time of the sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.specialServices"
            }
        },
        "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/equipments.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

The empty weight of the equipment by itself.

Match All

Show Source

• object amountType

{
    "description":"The empty weight of the equipment by itself.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : texts

Type: object

Show Source

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

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

Nested Schema : trackingEvents

Type: object

Show Source

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

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

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

UMLER Mileage Charge.

Match All

Show Source

• object currencyType

{
    "description":"UMLER Mileage Charge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : umChargeUnit

UMLER Mileage Charge Unit (example, 2).

Match All

Show Source

• object amountType

{
    "description":"UMLER Mileage Charge Unit (example, 2).",
    "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 : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "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 equipments.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.documents"
    }
}

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 : equipments.documents

Type: object

Show Source

• 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
  Represents the related document for consolidated/linked documents.
• 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.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

If attachment, date/time content was last updated

Match All

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Type: array

Show Source

• Array of: object equipments.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.refnums"
    }
}

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 : equipments.refnums

Type: object

Show Source

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

{
    "properties":{
        "equipmentRefnumQualGid":{
            "description":"The equipment reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The equipment reference number value.",
            "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 equipments.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.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 : equipments.remarks

Type: object

Show Source

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

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number of the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The Remark Qualifier ID.",
            "type":"string"
        },
        "remarkText":{
            "description":"The Text of the Remark.",
            "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 equipments.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.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 : equipments.specialServices

Type: object

Show Source

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

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special services being assigned to the equipment.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service.",
            "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.

Match All

Show Source

• object dateType

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

Nested Schema : expirationDate

The expiration date of this special service.

Match All

Show Source

• object dateType

{
    "description":"The expiration date of this special service.",
    "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
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipments.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.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 : equipments.statuses

Type: object

Show Source

• 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

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the equipment status.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "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 equipments.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.texts"
    }
}

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 : equipments.texts

Type: object

Show Source

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

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template related to equipment, The selected template is used with the text override option to populate the remark text.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"The GID of the document that should hold the text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "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 equipments.trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.trackingEvents"
    }
}

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 : equipments.trackingEvents

Type: object

Show Source

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

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier linked to the equipment.",
            "type":"number",
            "format":"int64"
        },
        "partitionKey":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"number",
            "format":"double"
        },
        "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 : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Back to Top