Get one release rule
get
/fscmRestApi/resources/11.13.18.05/releaseRules/{ReleaseRuleId}
Request
Path Parameters
-
ReleaseRuleId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : releaseRules-item-response
Type:
Show Source
object
-
AppendShipmentsFlag: boolean
Title:
Append shipments
Maximum Length:1
Contains one of the following values: true or false. If true, then add lines to the existing shipments. If false, then don't add lines to the existing shipments. The default value is false. -
AutomaticallyPackFlag: boolean
Title:
Automatically pack
Maximum Length:1
Contains one of the following values: true or false. If true, then shipment lines are packed automatically. If false, then shipment lines aren't packed automatically. The default value is false. -
AutoPickConfirmFlag: boolean
Title:
Autoconfirm picks
Maximum Length:1
Contains one of the following values: true or false. If true, then automatically confirm the pick transactions. If false, then don't automatically confirm the pick transactions. The default value is false. -
CatalogId: integer
(int64)
Value that uniquely identifies the catalog.
-
CatalogName: string
Maximum Length:
255
Name that determines the catalog. -
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Maximum Length:
255
Name that determines the item category. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the release rule. -
CreateShipmentsFlag: boolean
Title:
Create shipments
Maximum Length:1
Contains one of the following values: true or false. If true, then automatically assign released shipment lines to a shipment. If false, then don't automatically assign released shipment lines to a shipment. The default value is false. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the release rule. -
Customer: string
Maximum Length:
255
Name of the customer. -
CustomerId: integer
(int64)
Title:
Customer
Value that identifies the customer. -
DestinationType: string
Maximum Length:
255
Value that determines the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE. -
DestinationTypeCode: string
Title:
Destination Type
Abbreviation that identifies the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE. -
DocumentSetId: integer
(int64)
Value that identifies the document job set that's used for printing documents during pick release.
-
EndDateActive: string
(date-time)
Title:
End Date
Date when the release rule becomes inactive. -
EndRequestedDays: integer
Title:
Days
Indicates the number of days in the past or future to use for the end date in a range of dates when the customer requested to ship the goods. -
EndRequestedHours: integer
Title:
Time
Indicates the time used for the end date when the customer requested to ship the goods. -
EndScheduledShipDays: integer
Title:
Days
Indicates the number of days in the past or future to use for the end date in a range of dates when the customer scheduled to ship the goods. -
EndScheduledShipHours: integer
Title:
Time
Indicates the time used for the end date when the customer scheduled to ship the goods. -
FromRequestedDate: string
(date-time)
Title:
From Requested Date
Start date and time in a range of dates when the customer requested to ship the goods. -
FromScheduledShipDate: string
(date-time)
Title:
From Scheduled Ship Date
Start date and time in a range of dates when the customer scheduled to ship the goods. -
Geography: string
Maximum Length:
255
Value that determines the predefined administrative regions or geographies such as cities or states, a specified district or territory. -
GeographyElement1: string
Maximum Length:
255
Name of the denormalized parent of the geography. -
GeographyElement1Code: string
Maximum Length:
255
Abbreviation that identifies the first geography element. -
GeographyElement2: string
Maximum Length:
255
Name of the denormalized parent of the geography. -
GeographyElement3: string
Maximum Length:
255
Name of the denormalized parent of the geography. -
GeographyElement4: string
Maximum Length:
255
Name of the denormalized parent of the geography. -
GeographyElement5: string
Maximum Length:
255
Name of the denormalized parent of the geography. -
GeographyElement6: string
Maximum Length:
255
Name of the denormalized parent of the geography. -
GeographyId: integer
(int64)
Title:
Geography
Value that uniquely identifies the predefined administrative regions or geographies such as cities or states, a specified district or territory. -
IncludeAssignedLinesFlag: boolean
Title:
Include assigned lines
Maximum Length:1
Contains one of the following values: true or false. If true, then include lines already assigned to a shipment when creating a pick wave. If false, then don't include lines already assigned to a shipment when creating a pick wave. The default value is false. -
InitialDestination: string
Maximum Length:
255
Name that identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination. -
InitialDestinationAddress1: string
Maximum Length:
255
First line of the initial destination address. -
InitialDestinationAddress2: string
Maximum Length:
255
Second line of the initial destination address. -
InitialDestinationAddress3: string
Maximum Length:
255
Third line of the initial destination address. -
InitialDestinationAddress4: string
Maximum Length:
255
Fourth line of the initial destination address. -
InitialDestinationCity: string
Maximum Length:
255
City of the initial destination address. -
InitialDestinationCountry: string
Maximum Length:
255
Country of the initial destination address. -
InitialDestinationId: integer
(int64)
Value that uniquely identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination.
-
InitialDestinationPostalCode: string
Maximum Length:
255
Postal code of the initial destination address. -
InitialDestinationProvince: string
Maximum Length:
255
Province of the initial destination address. -
InitialDestinationState: string
Maximum Length:
255
State of the initial destination address. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory Item.
-
ItemDescription: string
Maximum Length:
255
Description of the item. -
ItemNumber: string
Maximum Length:
255
Number that identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the release rule. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the release rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderId: integer
(int64)
Value that uniquely identifies the sales order, or transfer order, or transfer order return.
-
OrderNumber: string
Maximum Length:
255
Number that identifies the sales order, or transfer order, or transfer order return. -
OrderType: string
Maximum Length:
255
Value that determines the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE. -
OrderTypeCode: string
Maximum Length:
100
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE. -
PickFromLocator: string
Maximum Length:
255
Name that identifies the locator from where to pick release. -
PickFromLocatorId: integer
(int64)
Title:
Pick-from Locator
Value that uniquely identifies the locator from where to pick release. -
PickFromSubinventory: string
Title:
Pick-from Subinventory
Maximum Length:10
Name of the subinventory from where to pick release or generate shipment request. -
PickSlipGroupingRule: string
Maximum Length:
255
Value of the criteria to determine the grouping of picks into pick slips. -
PickSlipGroupingRuleId: integer
(int64)
Value that uniquely identifies the criteria to determine the grouping of picks into pick slips.
-
PriorReservationsFlag: boolean
Title:
Prior reservations only
Maximum Length:1
Contains one of the following values: true or false. If true, then release existing reservations. If false, then don't release existing reservations. The default value is false. -
ProjectCostingProjectId: integer
(int64)
Value that uniquely identifies the project for standardized project cost collection.
-
ProjectCostingProjectName: string
Name of the project for standardized project cost collection.
-
ProjectCostingProjectNumber: string
Title:
Project Number
Number that identifies the project for standardized project cost collection. -
ProjectCostingTaskId: integer
(int64)
Value that uniquely identifies the task for standardized project cost collection.
-
ProjectCostingTaskName: string
Name of the task for standardized project cost collection.
-
ProjectCostingTaskNumber: string
Title:
Task Number
Number that identifies the task for standardized project cost collection. -
ReleaseRule: string
Title:
Name
Maximum Length:60
Name of the release rule. -
ReleaseRuleId: integer
(int64)
Unique identifier of the release rule.
-
ReleaseSequenceRule: string
Maximum Length:
255
Value that determines the sequencing of shipment lines for pick release or generating shipment requests. -
ReleaseSequenceRuleId: integer
(int64)
Value that uniquely identifies the sequencing of shipment lines for pick release or generating shipment requests.
-
ReleaseStatus: string
Maximum Length:
255
Value that determines the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG. -
ReleaseStatusCode: string
Title:
Release Status
Maximum Length:1
Default Value:E
Abbreviation that identifies the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG. -
ReleaseSubinventory: string
Maximum Length:
10
Name of the subinventory to source the material on shipment lines. -
ShipConfirmRule: string
Maximum Length:
255
Value that identifies the rules used on the shipment lines and shipment during ship confirmation. -
ShipConfirmRuleId: integer
(int64)
Value that uniquely identifies the rules used on the shipment lines and shipment at ship confirmation.
-
ShipFromOrganizationCode: string
Maximum Length:
18
Value that identifies the originating organization of the goods that are shipped. -
ShipFromOrganizationId: integer
(int64)
Title:
Ship-from Organization
Value that uniquely identifies the originating organization of the goods that are shipped. -
ShipFromOrganizationName: string
Maximum Length:
255
Name of the originating organization of the goods that are shipped. -
ShipmentCreationCriteria: string
Maximum Length:
255
Value that determines the criteria for grouping shipment lines into shipments. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA. -
ShipmentCreationCriteriaCode: string
Title:
Shipment Creation Criteria
Maximum Length:2
Abbreviation that identifies the criteria for grouping shipment lines into shipments. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA. -
ShipmentPriority: string
Maximum Length:
255
Value that indicates the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. -
ShipmentPriorityCode: string
Title:
Shipping Priority
Maximum Length:30
Abbreviation that identifies the shipment priority. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. -
ShipMethod: string
Maximum Length:
255
Value that indicates the method of shipping. -
ShipMethodCode: string
Maximum Length:
30
Abbreviation that identifies the shipping method. -
ShipSetName: string
Title:
Shipment Set
Maximum Length:150
Name of the shipment set to be selected for pick release or generating shipment request. -
ShipToAddress1: string
Maximum Length:
255
First line of the ship-to customer address. -
ShipToAddress2: string
Maximum Length:
255
Second line of the ship-to customer address. -
ShipToAddress3: string
Maximum Length:
255
Third line of the ship-to customer address. -
ShipToAddress4: string
Maximum Length:
255
Fourth line of the ship-to customer address. -
ShipToCity: string
Maximum Length:
255
City of the ship-to customer address. -
ShipToCountry: string
Maximum Length:
255
Country of the ship-to customer address. -
ShipToLocation: string
Maximum Length:
255
Value that determines the customer location where a supplier sends shipments of goods and services. -
ShipToLocationCode: string
Maximum Length:
255
Abbreviation that identifies the ship-to location. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Location
Value that uniquely identifies the customer location where a supplier sends shipments of goods and services. -
ShipToLocationType: string
Maximum Length:
2
Indicates whether the ship-to location is internal or external. -
ShipToNumber: string
Maximum Length:
255
Party site number of the ship-to customer address. -
ShipToPartyId: integer
(int64)
Title:
Customer
Value that uniquely identifies the ship-to party. -
ShipToPostalCode: string
Maximum Length:
255
Postal code of the ship-to customer address. -
ShipToRegion: string
Maximum Length:
255
Region of the ship-to customer address. -
ShipToState: string
Maximum Length:
255
State of the ship-to customer address. -
StagingLocator: string
Maximum Length:
255
Value that identifies the default locator where picked lines are staged. -
StagingLocatorId: integer
(int64)
Title:
Staging Locator
Value that uniquely identifies the default locator where picked lines are staged. -
StagingSubinventory: string
Title:
Staging Subinventory
Maximum Length:10
Value that identifies the default subinventory where picked lines are staged. -
StartDateActive: string
(date-time)
Title:
Start Date
Date when the release rule becomes active. -
StartRequestedDays: integer
Title:
Days
Indicates the number of days in the past or future to use for the start date in a range of dates when the customer requested to ship the goods. -
StartRequestedHours: integer
Title:
Time
Indicates the time used for the start date when the customer requested to ship the goods. -
StartScheduledShipDays: integer
Title:
Days
Indicates the number of days in the past or future to use for the start date in a range of dates when the customer scheduled to ship the goods. -
StartScheduledShipHours: integer
Title:
Time
Indicates the time used for the start date when the customer scheduled to ship the goods. -
ToRequestedDate: string
(date-time)
Title:
To Requested Date
Last date and time in a range of dates when the customer requested to ship the goods. -
ToScheduledShipDate: string
(date-time)
Title:
To Scheduled Ship Date
Last date and time in a range of dates when the customer scheduled to ship the goods. -
TradeComplianceMethod: string
Title:
Trade Compliance Screening Method
Maximum Length:30
Abbreviation that identifies the method used for the line to be screened for trade compliance. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD. -
TradeComplianceMethodMeaning: string
Maximum Length:
255
Value that indicates the method used for the line to be screened for trade compliance. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD. -
TransportationShipment: string
Title:
Transportation Shipment
Maximum Length:101
Value that indicates a shipment planned by the transportation management application. -
Zone: string
Maximum Length:
255
Value that determines the geographic region, such as a country or a range of postal codes. -
ZoneId: integer
(int64)
Title:
Zone
Value that uniquely identifies the geographic region, such as a country or a range of postal codes.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get one release rule.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/releaseRules/ReleaseRuleId"
For example, the following command gets the release rule for the release rule identifier 100000020219004.
curl -u username:password "https://servername/fscmRestApi/resources/version/releaseRules/100000020219004?onlyData=true"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "ShipmentCreationCriteriaCode": "Y", "AppendShipmentsFlag": null, "AutoPickConfirmFlag": true, "CreateShipmentsFlag": true, "AutomaticallyPackFlag": false, "ReleaseStatusCode": "E", "CategoryId": null, "CreatedBy": "SCM_USER29A", "CreationDate": "2010-10-26T09:24:58.657+00:00", "StagingLocatorId": null, "StagingSubinventory": "Staging1", "DestinationTypeCode": "S", "DocumentSetId": null, "EndDateActive": null, "PriorReservationsFlag": null, "FromRequestedDate": null, "FromScheduledShipDate": null, "IncludeAssignedLinesFlag": null, "InventoryItemId": null, "LastUpdateDate": "2010-10-27T06:38:59.362+00:00", "LastUpdatedBy": "SHIPPING_MANAGER_M1_SEATTLE_MANUFACTURING", "ShipFromOrganizationCode": "M1", "ShipFromOrganizationId": 207, "PickFromLocatorId": null, "PickFromSubinventory": null, "ReleaseRuleId": 100000020219004, "ReleaseRule": "M1 High Priority", "ProjectCostingProjectName": null, "ProjectCostingProjectNumber": null, "ProjectCostingTaskName": null, "ProjectCostingTaskNumber": null, "GeographyId": null, "GeographyElement1": null, "GeographyElement2": null, "GeographyElement3": null, "GeographyElement4": null, "GeographyElement5": null, "GeographyElement6": null, "ShipConfirmRuleId": 1, "ShipMethodCode": null, "ShipSetName": null, "ShipToLocationId": null, "ShipToLocationType": null, "CustomerId": null, "ShipmentPriorityCode": "HIGH", "StartDateActive": "2010-10-26T00:00:00+00:00", "ToRequestedDate": null, "ToScheduledShipDate": null, "TransportationShipment": null, "TradeComplianceMethod": null, "ZoneId": null, "ReleaseSubinventory": null, "ReleaseStatus": "Unreleased", "OrderTypeCode": null, "OrderType": null, "OrderId": null, "OrderNumber": null, "Customer": null, "ProjectCostingProjectId": null, "ProjectCostingTaskId": null, "ShipmentPriority": "High", "ShipMethod": null, "InitialDestinationId": null, "InitialDestination": null, "CatalogId": null, "CatalogName": null, "CategoryName": null, "ItemNumber": null, "ItemDescription": null, "ShipFromOrganizationName": "Seattle Manufacturing", "PickFromLocator": null, "StagingLocator": null, "ReleaseSequenceRuleId": 1000, "ReleaseSequenceRule": "All Standard Orders", "PickSlipGroupingRuleId": 1201, "PickSlipGroupingRule": "Departure, Delivery", "ShipmentCreationCriteria": "Within an order", "ShipConfirmRule": "Auto Ship", "DestinationType": "Ship to", "ShipToNumber": null, "ShipToAddress1": null, "ShipToAddress2": null, "ShipToAddress3": null, "ShipToAddress4": null, "ShipToCity": null, "ShipToState": null, "ShipToCountry": null, "ShipToPostalCode": null, "ShipToRegion": null, "ShipToLocation": null, "ShipToLocationCode": null, "InitialDestinationAddress1": null, "InitialDestinationAddress2": null, "InitialDestinationAddress3": null, "InitialDestinationAddress4": null, "InitialDestinationCountry": null, "InitialDestinationCity": null, "InitialDestinationPostalCode": null, "InitialDestinationState": null, "InitialDestinationProvince": null, "Geography": null, "Zone": null, "EndScheduledShipDays": null, "EndScheduledShipHours": null, "StartScheduledShipDays": null, "StartScheduledShipHours": null, "EndRequestedDays": null, "EndRequestedHours": null, "StartRequestedDays": null, "StartRequestedHours": null, "TradeComplianceMethodMeaning": null, "ShipToPartyId": null }