Get Role Profiles
get
/locations/{locationGid}/roleProfiles
Request
Path Parameters
-
locationGid(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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : locations.roleProfiles
Type:
Show Source
object
-
activityTimeDefs:
activityTimeDefs
-
calendarGid: string
The GID for the calendar used for the location role profile.
-
calendars:
calendars
-
createPoolHandlingShipment: boolean
Creates pool handling shipments.
-
createXdockHandlingShipment: boolean
Using the Create Crossdock Handling Shipment field creates handling shipments as part of the cross-dock building process. Clear the check box to bulk plan cross-docks without handling shipments.
Fixed Handling Time: Same as above.
The Variable Handling Time and the Variable Handling Weight: Same as above.
Max Freight Idle Time: Same as above. -
domainName: string
Database domain where this data is stored.
-
fixedHandlingTime:
fixedHandlingTime
Fixed amount of time. No matter the size of the shipment required for handling.
-
handlings:
handlings
-
isAllowMixedFreight: boolean
Check box option used to indicate if mixed freight (e.g., a rainbow pallet) will be allowed, is so then select the Allow Mixed Freight option.
-
links: array
links
Read Only:
true
-
locationRoleGid: string
The GID for the location role.
-
maxFreightIdleTime:
maxFreightIdleTime
Maximum time freight can sit idle at the cross-dock.
-
pctActivityAfterLocClose: number
(double)
This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100 100. when null, treat as for location role shipping receiving< div> =>
-
pctActivityBeforeLocOpen: number
(double)
This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 0 100. when it is null, treat as for location role shipping receiving< div> =>
-
thuCapacities:
thuCapacities
-
thuProfileGid: string
The GID for the transport profile.
To handle mixed items you need to include the THU profile here and on the order release line. You also need to attach appropriate packaging reference unit (PRU) to the THU to indicate that it is a mixed THU that takes only mixed items but does not take SAME or LIKE items. See Order Release Line help for details. -
varHandlingTime:
varHandlingTime
Amount of time required to handle the amount of weight defined by the variable handling weight value.
-
varHandlingWeight:
varHandlingWeight
Variable handling time weight defines rate of handling defined by weight.
-
varHndcstVol:
varHndcstVol
The planning handling cost volume at this location.
-
varHndcstVolCost:
varHndcstVolCost
The variable handling cost per volume at this location.
-
varHndcstWgt:
varHndcstWgt
The planning handling cost weight at this location.
-
varHndcstWgtCost:
varHndcstWgtCost
Variable Handling Cost Per Weight at this location.
-
xDockIsInboundBias: boolean
The inbound bias flag for the cross-dock should be selected if you want to emphasize optimization inbound to the cross-dock. If you clear the check box, then the system will optimize outbound from the cross-dock instead.
Nested Schema : activityTimeDefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : calendars
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : fixedHandlingTime
Fixed amount of time. No matter the size of the shipment required for handling.
Match All
Show Source
Nested Schema : handlings
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : maxFreightIdleTime
Maximum time freight can sit idle at the cross-dock.
Match All
Show Source
Nested Schema : thuCapacities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : varHandlingTime
Amount of time required to handle the amount of weight defined by the variable handling weight value.
Match All
Show Source
Nested Schema : varHandlingWeight
Variable handling time weight defines rate of handling defined by weight.
Match All
Show Source
Nested Schema : varHndcstVol
The planning handling cost volume at this location.
Match All
Show Source
Nested Schema : varHndcstVolCost
The variable handling cost per volume at this location.
Match All
Show Source
Nested Schema : varHndcstWgt
The planning handling cost weight at this location.
Match All
Show Source
Nested Schema : varHndcstWgtCost
Variable Handling Cost Per Weight at this location.
Match All
Show Source
Nested Schema : locations.roleProfiles.activityTimeDefs
Type:
Show Source
object
-
activityTimeDefGid: string
The GID for the activity time definition for this location and location role combination.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : locations.roleProfiles.calendars
Type:
Show Source
object
-
calendarGid: string
The GID for the calendar entry associated with each row of the location role profile calendar entry.
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfileGid: string
The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.
-
inboundLocationProfileGid: string
The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.
-
links: array
links
Read Only:
true
-
locationRoleProfCalSeq: number
(int32)
The internal sequence number for the location role profile calendar combination.
-
modeProfileGid: string
The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.
-
outboundLocationProfileGid: string
The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : locations.roleProfiles.handlings
Type:
Show Source
object
-
destRegionGid: string
The GID for the destination region. Used to match an order to an entry.
-
domainName: string
Database domain where this data is stored.
-
fixedHandlingTime:
fixedHandlingTime
Amount fixed handling time to add. Days, hours, and minutes.
-
links: array
links
Read Only:
true
-
locationRoleProfHandSeq: number
(int32)
Internal key for the 1 to n location role profile handling time entries.
-
sourceRegionGid: string
The GID for the source region. Used to match an order to an entry.
Nested Schema : fixedHandlingTime
Amount fixed handling time to add. Days, hours, and minutes.
Match All
Show Source
Nested Schema : locations.roleProfiles.thuCapacities
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
isFullyLayered: boolean
You should select the Fully Layered check box if this location only takes a full-layered ship unit based on the TiHi definition. A full-layered ship unit has no partial layers. For example, you are packing 23 boxes into a given PALLET (THU) and the TiHi specified for the pallet is 6 x 4. Normally, you would pack them onto one pallet with 3 full layers and one partial layer of 5 boxes. However, if you allow only full layers, you would pack only 3 full layers and leave the remaining 5 to pack with other items.
Building a full layered ship unit, when required, would only be honored when a ship unit is building from a single order release line using the AUTO CALC ship unit building method. It will not be honored when ship unit is built from multiple order release lines even when those lines have the same packaged item. -
links: array
links
Read Only:
true
-
maxHeight:
maxHeight
Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
-
maxLength:
maxLength
Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
-
maxVolume:
maxVolume
Value for the maximum volume of the transportation handling unit.
-
maxWeight:
maxWeight
Value for the maximum weight of the transportation handling unit.
-
maxWidth:
maxWidth
Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
-
pruCapacities:
pruCapacities
-
transportHandlingUnitGid: string
The GID for the transport handling unit.
Nested Schema : maxHeight
Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
Show Source
Nested Schema : maxLength
Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
Show Source
Nested Schema : maxVolume
Value for the maximum volume of the transportation handling unit.
Match All
Show Source
Nested Schema : maxWeight
Value for the maximum weight of the transportation handling unit.
Match All
Show Source
Nested Schema : maxWidth
Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
Match All
Show Source
Nested Schema : pruCapacities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.roleProfiles.thuCapacities.pruCapacities
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
limitPruCount: number
(double)
Enter a Total Packaging Reference Unit Count. This total represents by volume the amount of packaging reference units that can fill the space. It does not take into account the actual shape and dimensions of the packaging reference unit, but rather how many packaging reference units can fit in the space based on the volume of each packaging reference unit.
-
links: array
links
Read Only:
true
-
packagingReferenceUnitGid: string
The GID for the package unit reference unit.
-
totalPruCount: number
(double)
Enter a Limit Packaging Reference Unit Count. This represents the number of package references units that can fill the usable space in the location. The area of a location may suggest more packaging reference units can fit, but due to the actual dimensions of the packaged reference units, a lower limit may be reached.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency