Jump to

• Request
• Response

Get a Piece

get

/orderMovements/{orderMovementGid}/sShipUnits/{sShipUnitGid}/pieces/{pieceNumber}

Request

Path Parameters

• orderMovementGid(required): string
  Resource ID
• pieceNumber(required): string
  Resource ID
• sShipUnitGid(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 : orderMovements.sShipUnits.pieces

Type: object

Show Source

• domainName: string
  No description.
• height: height
  No description.
• isSplit: boolean
  To indicate if this is a loading split from the original SSU.
• length: length
  No description.
• links: array links
  Read Only: true
• loadConfig3dPatternGid: string
  Corresponding user defined 3d pattern. If the piece is placed using user defined 3d pattern, this indicates the pattern used.
• loadingSequence: number (int32)
  The loading sequence of the SSU singleton.
• orientationGid: string
  Orientation of the ship unit piece.
• patternInstanceCount: number (int32)
  Instance of the user pattern used
• pieceNumber: number (int32)
  A unique number given to a piece of SSU for the same S_SHIP_UNIT_GID with multiple counts.
• stackingLayer: number (int32)
  Stacking layers of the unit. If multiple units are underneath, this is the maximum number of layers underneath added by 1.
• totalTopWeight: totalTopWeight
  This is the summation of all weights on the top distributed according to the area touching the pieces
• volume: volume
  No description.
• weight: weight
  No description.
• width: width
  No description.
• xCoordinate: xCoordinate
  The x-coordinate of the unit using container's front lower left corner as the origin.
• yCoordinate: yCoordinate
  The y-coordinate of the unit using container's front lower left corner as the origin.
• zCoordinate: zCoordinate
  The z-coordinate of the unit using container's front lower left corner as the origin.

{
    "properties":{
        "pieceNumber":{
            "description":"A unique number given to a piece of SSU for the same S_SHIP_UNIT_GID with multiple counts.",
            "type":"number",
            "format":"int32"
        },
        "loadingSequence":{
            "description":"The loading sequence of the SSU singleton.",
            "type":"number",
            "format":"int32"
        },
        "stackingLayer":{
            "description":"Stacking layers of the unit. If multiple units are underneath, this is the maximum number of layers underneath added by 1.",
            "type":"number",
            "format":"int32"
        },
        "orientationGid":{
            "description":"Orientation of the ship unit piece.",
            "type":"string"
        },
        "xCoordinate":{
            "description":"The x-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "yCoordinate":{
            "description":"The y-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "zCoordinate":{
            "description":"The z-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "totalTopWeight":{
            "description":"This is the summation of all weights on the top distributed according to the area touching the pieces",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplit":{
            "description":"To indicate if this is a loading split from the original SSU.",
            "type":"boolean"
        },
        "length":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadConfig3dPatternGid":{
            "description":"Corresponding user defined 3d pattern. If the piece is placed using user defined 3d pattern, this indicates the pattern used.",
            "type":"string"
        },
        "patternInstanceCount":{
            "description":"Instance of the user pattern used",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : height

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

This is the summation of all weights on the top distributed according to the area touching the pieces

Match All

Show Source

• object amountType

{
    "description":"This is the summation of all weights on the top distributed according to the area touching the pieces",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volume

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : xCoordinate

The x-coordinate of the unit using container's front lower left corner as the origin.

Match All

Show Source

• object amountType

{
    "description":"The x-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : yCoordinate

The y-coordinate of the unit using container's front lower left corner as the origin.

Match All

Show Source

• object amountType

{
    "description":"The y-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : zCoordinate

The z-coordinate of the unit using container's front lower left corner as the origin.

Match All

Show Source

• object amountType

{
    "description":"The z-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top