Get a Piece
get
/sShipUnits/{sShipUnitGid}/pieces/{pieceNumber}
Request
Path Parameters
-
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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : sShipUnits.pieces
Type:
Show Source
object
-
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.
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
Nested Schema : xCoordinate
The x-coordinate of the unit using container's front lower left corner as the origin.
Match All
Show Source
Nested Schema : yCoordinate
The y-coordinate of the unit using container's front lower left corner as the origin.
Match All
Show Source
Nested Schema : zCoordinate
The z-coordinate of the unit using container's front lower left corner as the origin.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount