Jump to

• Request
• Response

Get an Equipment

get

/trackingEvents/{iTransactionNo}/equipments/{iRecNo}

Request

Path Parameters

• iRecNo(required): string
  Resource ID
• iTransactionNo(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 Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• aarCarType: string
  The AAR car type associated with the rail equipment on the tracking event.
• chassisInitial: string
  The chassis initial is a mark that is registered with national or international authorities that is associated with a specific owner
• chassisInitialNumber: string
  The Chassis Initial Number field is a concatenation of chassis initial and chassis number.
• chassisNumber: string
  Number identifying the used in conjunction with the equipment on the tracking event.
• domainName: string
  Database domain where this data is stored.
• equipmentGid: string
  The equipment GID if the equipment is an asset managed in OTM.
• equipmentInitial: string
  The equipment initial is a mark that is registered with national or international authorities that is associated with a specific owner.
• equipmentInitialNumber: string
  The Equipment Initial Number field is a concatenation of equipment initial and equipment number.
• equipmentNumber: string
  Number identifying the equipment used.
• equipmentRefnumQualGid: string
  The equipment reference number qualifier to identify an equipment entity for a tracking event.
• equipmentRefnumValue: string
  The equipment reference value associated with the equipment reference number qualifier.
• equipmentTypeGid: string
  An equipment type is a category of equipment. Oracle Transportation Management uses equipment types when it determines equipment capacity.
• intermodalEquipmentLength: number (double)
  The reported length of the equipment in the tracking event.
• iRecNo: number (int64)
  The record number primary key identifier for the tracking event specified.
• links: array links
  Read Only: true
• scaleLocation: string
  The scale location recorded for the tracking event.
• scaleName: string
  The received volume recorded on the tracking event for the shipment ship unit.
• scaleTicket: string
  Sequence ID printed on the scale ticket when weight is recorded.
• scaleWeight: scaleWeight
  The scale weight recorded on the tracking event for the shipment equipment.
• seals: seals
• sEquipmentGid: string
  The shipment equipment GID linking an equipment record to the shipment.
• sEquipmentIndex: number (int32)
  The standing order of the equipment on the shipment
• tareWeight: tareWeight
  The tare weight recorded on the tracking event for the shipment equipment.
• weightQualifier: string
  The type of weight that is represented by the scale weight; Estimate, Net, or Gross weight. E = Estimated, G = Gross, N = Net

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "sEquipmentGid":{
            "description":"The shipment equipment GID linking an equipment record to the shipment.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"The equipment initial is a mark that is registered with national or international authorities that is associated with a specific owner.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"Number identifying the equipment used.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"The Equipment Initial Number field is a concatenation of equipment initial and equipment number.",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"An equipment type is a category of equipment. Oracle Transportation Management uses equipment types when it determines equipment capacity.",
            "type":"string"
        },
        "intermodalEquipmentLength":{
            "description":"The reported length of the equipment in the tracking event.",
            "type":"number",
            "format":"double"
        },
        "tareWeight":{
            "description":"The tare weight recorded on the tracking event for the shipment equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "scaleName":{
            "description":"The received volume recorded on the tracking event for the shipment ship unit.",
            "type":"string"
        },
        "scaleLocation":{
            "description":"The scale location recorded for the tracking event.",
            "type":"string"
        },
        "scaleTicket":{
            "description":"Sequence ID printed on the scale ticket when weight is recorded.",
            "type":"string"
        },
        "scaleWeight":{
            "description":"The scale weight recorded on the tracking event for the shipment equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"The type of weight that is represented by the scale weight; Estimate, Net, or Gross weight. E = Estimated, G = Gross, N = Net",
            "type":"string"
        },
        "equipmentGid":{
            "description":"The equipment GID if the equipment is an asset managed in OTM.",
            "type":"string"
        },
        "equipmentRefnumQualGid":{
            "description":"The equipment reference number qualifier to identify an equipment entity for a tracking event.",
            "type":"string"
        },
        "equipmentRefnumValue":{
            "description":"The equipment reference value associated with the equipment reference number qualifier.",
            "type":"string"
        },
        "chassisInitial":{
            "description":"The chassis initial is a mark that is registered with national or international authorities that is associated with a specific owner",
            "type":"string"
        },
        "chassisNumber":{
            "description":"Number identifying the used in conjunction with the equipment on the tracking event.",
            "type":"string"
        },
        "chassisInitialNumber":{
            "description":"The Chassis Initial Number field is a concatenation of chassis initial and chassis number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sEquipmentIndex":{
            "description":"The standing order of the equipment on the shipment",
            "type":"number",
            "format":"int32"
        },
        "aarCarType":{
            "description":"The AAR car type associated with the rail equipment on the tracking event.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.equipments.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : scaleWeight

The scale weight recorded on the tracking event for the shipment equipment.

Match All

The scale weight recorded on the tracking event for the shipment equipment.

Show Source

• object amountType

{
    "description":"The scale weight recorded on the tracking event for the shipment equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : seals

Type: object

Show Source

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

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

Nested Schema : tareWeight

The tare weight recorded on the tracking event for the shipment equipment.

Match All

The tare weight recorded on the tracking event for the shipment equipment.

Show Source

• object amountType

{
    "description":"The tare weight recorded on the tracking event for the shipment equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : trackingEvents.equipments.seals

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• sealNumber: string
  The seal number that identifies the seal tag.
• sealSequence: number (int32)
  The seal sequence number that refers to the compartment that is being sealed.
• sEquipmentGid: string
  The shipment equipment GID.

{
    "properties":{
        "sealSequence":{
            "description":"The seal sequence number that refers to the compartment that is being sealed.",
            "type":"number",
            "format":"int32"
        },
        "sEquipmentGid":{
            "description":"The shipment equipment GID.",
            "type":"string"
        },
        "sealNumber":{
            "description":"The seal number that identifies the seal tag.",
            "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
}

Back to Top