Get a Bulk Plan
get
/bulkPlans/{bulkPlanGid}
Request
Path Parameters
-
bulkPlanGid(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 : bulkPlans
Type:
Show Source
object
-
appMachineGid: string
No description.
-
bulkPlanGid: string
No description.
-
bulkPlanXid: string
No description.
-
byModes:
byModes
-
continuousMoves:
continuousMoves
-
description: string
No description.
-
domainName: string
No description.
-
endTime:
endTime
No description.
-
insertDate:
insertDate
Read Only:
true
insert date -
links: array
links
Read Only:
true
-
logProcessId: number
(int64)
No description.
-
numOfOrdersPlanned: number
(int32)
No description.
-
numOfOrdersSelected: number
(int32)
No description.
-
numOfOrdersThruPool: number
(int32)
No description.
-
numOfOrdersThruXdock: number
(int32)
No description.
-
numOfOrdersUnassigned: number
(int32)
No description.
-
numOfShipmentsBuilt: number
(int32)
No description.
-
numOfWaCreated: number
(double)
No description.
-
numOrderMovementsCreated: number
(int32)
No description.
-
numOrderMovementsExcluded: number
(int32)
No description.
-
numOrderMovementsFailed: number
(int32)
No description.
-
numOrderMovementsPlanned: number
(int32)
No description.
-
numOrderMovementsSelected: number
(int32)
No description.
-
numOrderMovementsUnassigned: number
(int32)
No description.
-
numOrdersExcluded: number
(int32)
No description.
-
numOrdersPlannedFailed: number
(int32)
No description.
-
partitions:
partitions
-
perspective: string
No description.
-
planningParameterSetGid: string
No description.
-
projectGid: string
No description.
-
queryName: string
No description.
-
scenarioGid: string
No description.
-
scenarioGroup: string
No description.
-
serviceProviders:
serviceProviders
-
shipmentsSuppressed: boolean
No description.
-
since:
since
No description.
-
startTime:
startTime
No description.
-
state: string
No description.
-
terminationReason: string
No description.
-
terminationTime:
terminationTime
No description.
-
terminationUser: string
No description.
-
totalActualCost:
totalActualCost
No description.
-
totalBestDirectCost:
totalBestDirectCost
No description.
-
totalCost:
totalCost
No description.
-
totalDistance:
totalDistance
No description.
-
totalNumStops: number
(int32)
No description.
-
totalShipmentTimeSecs:
totalShipmentTimeSecs
No description.
-
totalVolume:
totalVolume
No description.
-
totalVolumeCapacity:
totalVolumeCapacity
No description.
-
totalWeight:
totalWeight
No description.
-
totalWeightCapacity:
totalWeightCapacity
No description.
-
updateDate:
updateDate
Read Only:
true
update date -
workAssignmentBulkPlanGid: string
No description.
Nested Schema : byModes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : continuousMoves
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : partitions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : serviceProviders
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : bulkPlans.byModes
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
numOrderMovementsPlanned: number
(int32)
No description.
-
numOrdersPlanned: number
(int32)
No description.
-
numShipmentsBuilt: number
(int32)
No description.
-
totalCost:
totalCost
No description.
-
totalDistance:
totalDistance
No description.
-
totalNumStops: number
(int32)
No description.
-
totalShipmentTimeSecs:
totalShipmentTimeSecs
No description.
-
totalVolume:
totalVolume
No description.
-
totalVolumeCapacity:
totalVolumeCapacity
No description.
-
totalWeight:
totalWeight
No description.
-
totalWeightCapacity:
totalWeightCapacity
No description.
-
transportModeGid: string
No description.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : bulkPlans.continuousMoves
Type:
Show Source
object
-
appMachineGid: string
No description.
-
bulkCmGid: string
No description.
-
bulkCmXid: string
No description.
-
cmWithFiveShipments: number
(int32)
No description.
-
cmWithFourShipments: number
(int32)
No description.
-
cmWithSixOrMoreShipments: number
(int32)
No description.
-
cmWithThreeShipments: number
(int32)
No description.
-
cmWithTwoShipments: number
(int32)
No description.
-
description: string
No description.
-
domainName: string
No description.
-
endTime:
endTime
No description.
-
links: array
links
Read Only:
true
-
logProcessId: number
(int64)
No description.
-
numOfCmCreated: number
(int32)
No description.
-
numOfShipmentsLinked: number
(int32)
No description.
-
numOfShipmentsSelected: number
(int32)
No description.
-
numShipmentsConsidered: number
(int32)
No description.
-
planningParameterSetGid: string
No description.
-
queryName: string
No description.
-
startTime:
startTime
No description.
-
state: string
No description.
-
totalCostAfter:
totalCostAfter
No description.
-
totalCostBefore:
totalCostBefore
No description.
-
totalDistanceAfter:
totalDistanceAfter
No description.
-
totalDistanceBefore:
totalDistanceBefore
No description.
-
totalEmptyDistance:
totalEmptyDistance
No description.
-
totalLoadedDistance:
totalLoadedDistance
No description.
-
totalTimeForAllCm:
totalTimeForAllCm
No description.
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : bulkPlans.partitions
Type:
Show Source
object
-
appMachineGid: string
No description.
-
byModes:
byModes
-
domainName: string
No description.
-
endTime:
endTime
No description.
-
links: array
links
Read Only:
true
-
logProcessId: number
(int64)
No description.
-
numOfOrdersPlanned: number
(int32)
No description.
-
numOfOrdersSelected: number
(int32)
No description.
-
numOfOrdersThruPool: number
(int32)
No description.
-
numOfOrdersThruXdock: number
(int32)
No description.
-
numOfOrdersUnassigned: number
(int32)
No description.
-
numOfShipmentsBuilt: number
(int32)
No description.
-
numOfWaCreated: number
(double)
No description.
-
numOrderMovementsCreated: number
(int32)
No description.
-
numOrderMovementsFailed: number
(int32)
No description.
-
numOrderMovementsPlanned: number
(int32)
No description.
-
numOrderMovementsSelected: number
(int32)
No description.
-
numOrderMovementsUnassigned: number
(int32)
No description.
-
numOrdersPlannedFailed: number
(int32)
No description.
-
partitionGid: string
No description.
-
serviceProviders:
serviceProviders
-
since:
since
No description.
-
startTime:
startTime
No description.
-
state: string
No description.
-
submitTime:
submitTime
No description.
-
totalBestDirectCost:
totalBestDirectCost
No description.
-
totalCost:
totalCost
No description.
-
totalDistance:
totalDistance
No description.
-
totalNumStops: number
(int32)
No description.
-
totalShipmentTimeSecs:
totalShipmentTimeSecs
No description.
-
totalVolume:
totalVolume
No description.
-
totalVolumeCapacity:
totalVolumeCapacity
No description.
-
totalWeight:
totalWeight
No description.
-
totalWeightCapacity:
totalWeightCapacity
No description.
Nested Schema : byModes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : serviceProviders
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : bulkPlans.partitions.byModes
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
numOrderMovementsPlanned: number
(int32)
No description.
-
numOrdersPlanned: number
(int32)
No description.
-
numShipmentsBuilt: number
(int32)
No description.
-
totalCost:
totalCost
No description.
-
totalDistance:
totalDistance
No description.
-
totalNumStops: number
(int32)
No description.
-
totalShipmentTimeSecs:
totalShipmentTimeSecs
No description.
-
totalVolume:
totalVolume
No description.
-
totalVolumeCapacity:
totalVolumeCapacity
No description.
-
totalWeight:
totalWeight
No description.
-
totalWeightCapacity:
totalWeightCapacity
No description.
-
transportModeGid: string
No description.
Nested Schema : bulkPlans.partitions.serviceProviders
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
numOrderMovementsPlanned: number
(int32)
No description.
-
numOrdersPlanned: number
(int32)
No description.
-
numShipmentsBuilt: number
(int32)
No description.
-
servprovGid: string
No description.
-
totalCost:
totalCost
No description.
-
totalDistance:
totalDistance
No description.
-
totalNumStops: number
(int32)
No description.
-
totalShipmentTimeSecs:
totalShipmentTimeSecs
No description.
-
totalVolume:
totalVolume
No description.
-
totalVolumeCapacity:
totalVolumeCapacity
No description.
-
totalWeight:
totalWeight
No description.
-
totalWeightCapacity:
totalWeightCapacity
No description.
Nested Schema : bulkPlans.serviceProviders
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
numOrderMovementsPlanned: number
(int32)
No description.
-
numOrdersPlanned: number
(int32)
No description.
-
numShipmentsBuilt: number
(int32)
No description.
-
servprovGid: string
No description.
-
totalCost:
totalCost
No description.
-
totalDistance:
totalDistance
No description.
-
totalNumStops: number
(int32)
No description.
-
totalShipmentTimeSecs:
totalShipmentTimeSecs
No description.
-
totalVolume:
totalVolume
No description.
-
totalVolumeCapacity:
totalVolumeCapacity
No description.
-
totalWeight:
totalWeight
No description.
-
totalWeightCapacity:
totalWeightCapacity
No description.