Service Directory > v32.1 > Inventory > Get_Inventory_Put-Away_Rules
 

Operation: Get_Inventory_Put-Away_Rules

Get operation for Inventory Put-Away Rules


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Inventory_Put-Away_Rules_Request

Get Inventory Put-Away Rules Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Inventory_Put-Away_Rule_Request_References  [0..*]  Reference to Inventory Put-Away Rule element   
Request_Criteria [Choice]   Inventory_Put-Away_Rule_Request_Criteria  [0..1]  Rule request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Inventory_Put-Away_Rules_Response

Get Inventory Put-Away Rules response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Inventory_Put-Away_Rule_Request_References  [0..1]  Inventory Put-Away Rule Request Reference element   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Inventory_Put-Away_Rule_Response_Data  [0..1]  Inventory Put-Away Rule Data   
top
 

Inventory_Put-Away_Rule_Request_References

part of: Get_Inventory_Put-Away_Rules_Request, Get_Inventory_Put-Away_Rules_Response
Reference to Inventory Put-Away Rule element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Put-Away_Rule_Reference  Inventory_Put-Away_RuleObject  [1..*]  Reference to Inventory Put-Away Rule element   
top
 

Inventory_Put-Away_RuleObject

part of: Inventory_Put-Away_Rule_Request_References, Inventory_Put-Away_Rule
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Inventory_Put-Away_RuleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Inventory_Put-Away_RuleObjectID

part of: Inventory_Put-Away_RuleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Inventory_Put-Away_Rule_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Inventory_Put-Away_Rule_Request_Criteria

part of: Get_Inventory_Put-Away_Rules_Request
Element containing Get Inventory Put-Away Rules Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Company Reference   
Ship-To_Reference  Unique_IdentifierObject  [0..*]  Ship-To Reference   
Deliver-To_Reference  LocationObject  [0..1]  Deliver-To Reference   
Supplier_Reference  Resource_ProviderObject  [0..*]  Supplier Reference   
Spend_Category_Reference  Spend_CategoryObject  [0..*]  Spend Category Reference   
Item_Reference  Purchase_ItemObject  [0..*]  Item Reference   
top
 

CompanyObject

part of: Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unique_IdentifierObject

part of: Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

LocationObject

part of: Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Resource_ProviderObject

part of: Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Resource_ProviderObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Resource_ProviderObjectID

part of: Resource_ProviderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Supplier_ID, Supplier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Spend_CategoryObject

part of: Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Spend_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Spend_CategoryObjectID

part of: Spend_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Spend_Category_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Purchase_ItemObject

part of: Inventory_Put-Away_Rule_Data, Inventory_Put-Away_Rule_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Purchase_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_ItemObjectID

part of: Purchase_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Inventory_Put-Away_Rules_Request, Get_Inventory_Put-Away_Rules_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Inventory_Put-Away_Rules_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Inventory_Put-Away_Rule_Response_Data

part of: Get_Inventory_Put-Away_Rules_Response
Inventory Put-Away Rule response data
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Put-Away_Rule  Inventory_Put-Away_Rule  [0..*]  Inventory Put-Away Rule element   
top
 

Inventory_Put-Away_Rule

part of: Inventory_Put-Away_Rule_Response_Data
Inventory Put-Away Rule element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Put-Away_Rule_Reference  Inventory_Put-Away_RuleObject  [0..1]  Reference to Inventory Put-Away Rule   
Inventory_Put-Away_Rule_Data  Inventory_Put-Away_Rule_Data  [0..*]  Inventory Put-Away Rule Data 
Validation Description
Select an inventory stocking location that is valid for this company  Select an inventory stocking location that is valid for this company 
Select a Location that's valid for this Inventory Site.  Select a Location that's valid for this Inventory Site. 
Select an Inventory Site that's valid for this stocking location or leave it empty when use default stocking location is false.  Select an Inventory Site that's valid for this stocking location or leave it empty when use default stocking location is false. 
Select an Inventory Site that's valid for this company when use default stocking location is true.  Select an Inventory Site that's valid for this company when use default stocking location is true. 
Select a deliver-to location that is valid for the resulting inventory location or resulting inventory site  Select a deliver-to location that is valid for the resulting inventory location or resulting inventory site 
Cannot enter stocking location when use default stocking location is selected  Cannot enter stocking location when use default stocking location is selected 
Stocking location must be owned.  Stocking location must be owned. 
Stocking location must be consigned.  Stocking location must be consigned. 
Either Owned or Consigned Stocking Location is required when not using Default Stocking Location.  Either Owned or Consigned Stocking Location is required when not using Default Stocking Location. 
Owned and Consigned stocking locations must be in the same site.  Owned and Consigned stocking locations must be in the same site. 
 
top
 

Inventory_Put-Away_Rule_Data

part of: Inventory_Put-Away_Rule
Inventory Put-Away Rule data payload
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Order  string  [0..1]  Inventory Put-Away Rule Order   
Company_Reference  CompanyObject  [1..1]  Company for Inventory Put-Away Rules   
Ship-To_Address_Reference  Unique_IdentifierObject  [0..*]  Ship-To Address for Inventory Put-Away Rules   
Deliver-To_Location_Reference  LocationObject  [0..1]  Deliver-To Location for Put Aaway Rules   
Supplier_Reference  Resource_ProviderObject  [0..*]  Supplier   
Spend_Category_Reference  Spend_CategoryObject  [0..*]  Active Spend Categories   
Item_Reference  Purchase_ItemObject  [0..*]  Purchase Item   
Use_Default_Stocking_Location  boolean  [0..1]  Use Defaulting Stocking Location from Purchase Item   
Inventory_Site_for_Company_Reference  LocationObject  [0..1]  Inventory Site   
Inventory_Locations_for_an_Inventory_Site_Reference  LocationObject  [0..1]  Inventory Location   
Consigned_Stocking_Location_Reference  LocationObject  [0..1]  Consigned Stocking Location   
Automatic_Put-Away  boolean  [0..1]  Automatic Put-Away flag   
Validation Description
Select an inventory stocking location that is valid for this company  Select an inventory stocking location that is valid for this company 
Select a Location that's valid for this Inventory Site.  Select a Location that's valid for this Inventory Site. 
Select an Inventory Site that's valid for this stocking location or leave it empty when use default stocking location is false.  Select an Inventory Site that's valid for this stocking location or leave it empty when use default stocking location is false. 
Select an Inventory Site that's valid for this company when use default stocking location is true.  Select an Inventory Site that's valid for this company when use default stocking location is true. 
Select a deliver-to location that is valid for the resulting inventory location or resulting inventory site  Select a deliver-to location that is valid for the resulting inventory location or resulting inventory site 
Cannot enter stocking location when use default stocking location is selected  Cannot enter stocking location when use default stocking location is selected 
Stocking location must be owned.  Stocking location must be owned. 
Stocking location must be consigned.  Stocking location must be consigned. 
Either Owned or Consigned Stocking Location is required when not using Default Stocking Location.  Either Owned or Consigned Stocking Location is required when not using Default Stocking Location. 
Owned and Consigned stocking locations must be in the same site.  Owned and Consigned stocking locations must be in the same site. 
top
 

Inventory_Put-Away_RuleReferenceEnumeration

part of: Inventory_Put-Away_RuleObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top