Jump to

• Request
• Response

Get Line Items

get

/damageClaims/{claimGid}/lineItems

Request

Path Parameters

• claimGid(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.
• 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/damageClaims.lineItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.lineItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.lineItems"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : damageClaims.lineItems

Type: object

Show Source

• costs: costs
• damagedFraction: number (double)
  Percentage of damage.
• damagedQuantity: number (int64)
  Quantity of damaged goods.
• damagedVolume: damagedVolume
  Volume of damaged portion.
• damagedWeight: damagedWeight
  Weight of damaged portion.
• damageTypeGid: string
  Type of damage; these values are user defined.
• declaredValue: declaredValue
  Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.
• domainName: string
  Database domain where this data is stored.
• lineItemSeqNo: number (int64)
  Sequence number to keep claim line items unique; actual line items should start with sequence number 1; 0 is reserved to attach costs that relate to the claim as a whole.
• links: array links
  Read Only: true
• newCylinderDiam: newCylinderDiam
  For cylindrical objects, the new diameter of the object.
• newQuantity: number (int64)
  New quantity after reconditioning activities.
• newVolume: newVolume
  New volume after reconditioning activities
• newWeight: newWeight
  New weight after reconditioning activities.
• orderReleaseLineGid: string
  The GID for the order release (if applicable) to which this claim line item applies.
• origCylCoreDiam: origCylCoreDiam
  For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.
• origCylinderDiam: origCylinderDiam
  For cylindrical objects, the original diameter prior to damage.
• originalQuantity: number (int64)
  Total or original quantity for the line item (undamaged + damaged goods).
• originalVolume: originalVolume
  Total or original volume for the line item (undamaged + damaged goods).
• originalWeight: originalWeight
  Total or original weight for the line item (undamaged + damaged goods).
• packageStatusGid: string
  Indicates the status of packages on the claim line item.
• pricePerUnit: pricePerUnit
  Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.
• pricePerUnitUomCode: string
  UOM for the per value for size of loss (for a $10/lb. value, this field represents the 'lb.' part); used in the damage value calculation.
• pricePerUnitUomType: string
  UOM type of the unit for which sales value is defined such as 'weight' or 'volume'; used in the damage value calculation.
• refnums: refnums
• removedCylDepth: removedCylDepth
  For cylindrical objects, the depth from the outer edge of the cylinder that was removed.
• removedFraction: number (double)
  Percentage of goods removed as part of reconditioning.
• removedQuantity: number (int64)
  Quantity of goods that were removed as part of reconditioning.
• removedVolume: removedVolume
  Volume of portion that was removed as part of reconditioning.
• removedWeight: removedWeight
  Weight of portion that was removed as part of reconditioning.
• serialNumber: string
  Serial number for the claim line item.
• sizeOfLoss: sizeOfLoss
  The calculated total of all claim line item costs for this claim line item.
• transportHandlingUnitGid: string
  Transport handling unit for the claim line item.

{
    "properties":{
        "lineItemSeqNo":{
            "description":"Sequence number to keep claim line items unique; actual line items should start with sequence number 1; 0 is reserved to attach costs that relate to the claim as a whole.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"The GID for the order release (if applicable) to which this claim line item applies.",
            "type":"string"
        },
        "serialNumber":{
            "description":"Serial number for the claim line item.",
            "type":"string"
        },
        "damageTypeGid":{
            "description":"Type of damage; these values are user defined.",
            "type":"string"
        },
        "damagedWeight":{
            "description":"Weight of damaged portion.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "damagedVolume":{
            "description":"Volume of damaged portion.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "damagedQuantity":{
            "description":"Quantity of damaged goods.",
            "type":"number",
            "format":"int64"
        },
        "damagedFraction":{
            "description":"Percentage of damage.",
            "type":"number",
            "format":"double"
        },
        "originalWeight":{
            "description":"Total or original weight for the line item (undamaged + damaged goods).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "originalVolume":{
            "description":"Total or original volume for the line item (undamaged + damaged goods).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "originalQuantity":{
            "description":"Total or original quantity for the line item (undamaged + damaged goods).",
            "type":"number",
            "format":"int64"
        },
        "newWeight":{
            "description":"New weight after reconditioning activities.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "newVolume":{
            "description":"New volume after reconditioning activities",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "newQuantity":{
            "description":"New quantity after reconditioning activities.",
            "type":"number",
            "format":"int64"
        },
        "removedWeight":{
            "description":"Weight of portion that was removed as part of reconditioning.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedVolume":{
            "description":"Volume of portion that was removed as part of reconditioning.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedQuantity":{
            "description":"Quantity of goods that were removed as part of reconditioning.",
            "type":"number",
            "format":"int64"
        },
        "origCylinderDiam":{
            "description":"For cylindrical objects, the original diameter prior to damage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "origCylCoreDiam":{
            "description":"For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedCylDepth":{
            "description":"For cylindrical objects, the depth from the outer edge of the cylinder that was removed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "newCylinderDiam":{
            "description":"For cylindrical objects, the new diameter of the object.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedFraction":{
            "description":"Percentage of goods removed as part of reconditioning.",
            "type":"number",
            "format":"double"
        },
        "declaredValue":{
            "description":"Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packageStatusGid":{
            "description":"Indicates the status of packages on the claim line item.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"Transport handling unit for the claim line item.",
            "type":"string"
        },
        "pricePerUnit":{
            "description":"Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pricePerUnitUomType":{
            "description":"UOM type of the unit for which sales value is defined such as 'weight' or 'volume'; used in the damage value calculation.",
            "type":"string"
        },
        "pricePerUnitUomCode":{
            "description":"UOM for the per value for size of loss (for a $10/lb. value, this field represents the 'lb.' part); used in the damage value calculation.",
            "type":"string"
        },
        "sizeOfLoss":{
            "description":"The calculated total of all claim line item costs for this claim line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.lineItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.lineItems.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.lineItems.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : damagedVolume

Volume of damaged portion.

Match All

Show Source

• object amountType

{
    "description":"Volume of damaged portion.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : damagedWeight

Weight of damaged portion.

Match All

Show Source

• object amountType

{
    "description":"Weight of damaged portion.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : declaredValue

Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.

Match All

Show Source

• object currencyType

{
    "description":"Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

For cylindrical objects, the new diameter of the object.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the new diameter of the object.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : newVolume

New volume after reconditioning activities

Match All

Show Source

• object amountType

{
    "description":"New volume after reconditioning activities",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : newWeight

New weight after reconditioning activities.

Match All

Show Source

• object amountType

{
    "description":"New weight after reconditioning activities.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : origCylCoreDiam

For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : origCylinderDiam

For cylindrical objects, the original diameter prior to damage.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the original diameter prior to damage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : originalVolume

Total or original volume for the line item (undamaged + damaged goods).

Match All

Show Source

• object amountType

{
    "description":"Total or original volume for the line item (undamaged + damaged goods).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : originalWeight

Total or original weight for the line item (undamaged + damaged goods).

Match All

Show Source

• object amountType

{
    "description":"Total or original weight for the line item (undamaged + damaged goods).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pricePerUnit

Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.

Match All

Show Source

• object currencyType

{
    "description":"Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

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

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

Nested Schema : removedCylDepth

For cylindrical objects, the depth from the outer edge of the cylinder that was removed.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the depth from the outer edge of the cylinder that was removed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : removedVolume

Volume of portion that was removed as part of reconditioning.

Match All

Show Source

• object amountType

{
    "description":"Volume of portion that was removed as part of reconditioning.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : removedWeight

Weight of portion that was removed as part of reconditioning.

Match All

Show Source

• object amountType

{
    "description":"Weight of portion that was removed as part of reconditioning.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : sizeOfLoss

The calculated total of all claim line item costs for this claim line item.

Match All

Show Source

• object currencyType

{
    "description":"The calculated total of all claim line item costs for this claim line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.lineItems.costs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.lineItems.costs"
    }
}

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 : damageClaims.lineItems.costs

Type: object

Show Source

• claimCostTypeGid: string
  The cost type such as DAMAGE or SALVAGE.
• cost: cost
  The cost amount.
• costSeqNo: number (int64)
  The sequence number to keep costs on claim lines unique.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• payeeContactGid: string
  The GID for the payee contact.
• payorContactGid: string
  The GID for the payer contact.

{
    "properties":{
        "costSeqNo":{
            "description":"The sequence number to keep costs on claim lines unique.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"The cost amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "claimCostTypeGid":{
            "description":"The cost type such as DAMAGE or SALVAGE.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "payeeContactGid":{
            "description":"The GID for the payee contact.",
            "type":"string"
        },
        "payorContactGid":{
            "description":"The GID for the payer contact.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost amount.

Match All

Show Source

• object currencyType

{
    "description":"The cost amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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"
        }
    }
}

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 damageClaims.lineItems.refnums

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

Type: object

Show Source

• claimLiRefnumQualGid: string
  The qualifier for the reference number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• refnumValue: string
  The value of reference number.

{
    "properties":{
        "claimLiRefnumQualGid":{
            "description":"The qualifier for the reference number.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value of reference number.",
            "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