Service Directory > v32.1 > Resource_Management > Get_Asset_Pooling_Rules
 

Operation: Get_Asset_Pooling_Rules

This service allows you to get asset pooling rules. Asset Pooling Rules are ordered, and are based on Company, Spend Category, Item, Currency, Quantity Greater Than, and Unit Cost Less Than.


@ - 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_Asset_Pooling_Rules_Request

Request element for the asset pooling rules operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Asset_Pooling_Rule_Request_References  [0..1]  Element containing request references for the asset pooling rules operation   
Request_Criteria [Choice]   Asset_Pooling_Rule_Request_Criteria  [0..1]  Element containing request criteria for the asset pooling rules operation   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Asset_Pooling_Rule_Response_Group  [0..1]  Element containing response group for the asset pooling rules operation   
top
 

Response Element: Get_Asset_Pooling_Rules_Response

Element containing request and response elements for the asset pooling rule operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Asset_Pooling_Rule_Request_References  [0..1]  Element containing request references for the asset pooling rules operation   
Request_Criteria  Asset_Pooling_Rule_Request_Criteria  [0..1]  Element containing request criteria for the asset pooling rules operation   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Asset_Pooling_Rule_Response_Group  [0..1]  Element containing response group for the asset pooling rules operation   
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Asset_Pooling_Rule_Response_Data  [0..1]  Response element for the Asset Pooling Rules operation   
top
 

Asset_Pooling_Rule_Request_References

part of: Get_Asset_Pooling_Rules_Request, Get_Asset_Pooling_Rules_Response
Element containing request references for the asset pooling rules operation
 
Parameter name Type/Value Cardinality Description Validations
Asset_Pooling_Rule_Reference  Asset_Pooling_RuleObject  [1..*]  Reference to an existing asset pooling rule to which the asset pooling rule data applies   
top
 

Asset_Pooling_RuleObject

part of: Asset_Pooling_Rule_Request_References, Asset_Pooling_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  Asset_Pooling_RuleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Asset_Pooling_RuleObjectID

part of: Asset_Pooling_RuleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Asset_Pooling_Rule_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
 

Asset_Pooling_Rule_Request_Criteria

part of: Get_Asset_Pooling_Rules_Request, Get_Asset_Pooling_Rules_Response
Element containing request criteria for the asset pooling rules operation
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Asset_Pooling_Rules_Request, Get_Asset_Pooling_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
 

Asset_Pooling_Rule_Response_Group

part of: Get_Asset_Pooling_Rules_Request, Get_Asset_Pooling_Rules_Response
Element containing response group for the asset pooling rules operation
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference boolean element   
top
 

Response_Results

part of: Get_Asset_Pooling_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
 

Asset_Pooling_Rule_Response_Data

part of: Get_Asset_Pooling_Rules_Response
Response element for the Asset Pooling Rules operation
 
Parameter name Type/Value Cardinality Description Validations
Asset_Pooling_Rule  Asset_Pooling_Rule  [0..*]  Element containing all Asset Pooling Rules   
top
 

Asset_Pooling_Rule

part of: Asset_Pooling_Rule_Response_Data
Element containing a reference to an existing asset pooling rule and its asset pooling rule data
 
Parameter name Type/Value Cardinality Description Validations
Asset_Pooling_Rule_Reference  Asset_Pooling_RuleObject  [0..1]  Reference to an existing asset pooling rule to which the asset pooling rule data applies   
Asset_Pooling_Rule_Data  Asset_Pooling_Rule_Data  [0..*]  Element containing all the Asset Pooling Rules   
top
 

Asset_Pooling_Rule_Data

part of: Asset_Pooling_Rule
Element containing all Asset Pooling Rules
 
Parameter name Type/Value Cardinality Description Validations
Asset_Pooling_Rule_Replacement_Data  Asset_Pooling_Rule_Replacement_Data  [0..*]  Element containing asset pooling rule replacement data. 
Validation Description
Either Spend Category or Item must be specified.   
Use another ID for the Asset Pooling Rule or unset the Add Only attribute. An Asset Pooling Rule Rule already exists for the ID [ID].  The Put Asset Pooling Rule web service cannot be used to edit an existing rule; it can only add rules, or replace all rules. 
Rule order must be unique.   
 
top
 

Asset_Pooling_Rule_Replacement_Data

part of: Asset_Pooling_Rule_Data
Element containing asset pooling rule replacement data.
 
Parameter name Type/Value Cardinality Description Validations
Asset_Pooling_Rule_ID  string  [0..1]  This is a unique reference identifier to the set of asset pooling rules.   
Asset_Pooling_Rule_Order  string  [0..1]  Used to define the order of the rules (ascending).   
Company_Reference  OrganizationObject  [0..*]  Reference to existing companies or company hierarchies to which the asset pooling rule applies. 
Validation Description
One or more companies for a rule for Spend Category ([spend category]) have a company currency that does not match the currency specified.   
 
Spend_Category_or_Hierarchy_Reference  Spend_Category_or_HierarchyObject  [0..*]  Reference to existing spend categories or spend category hierarchies to which the asset pooling rule applies. 
Validation Description
Invalid Spend Category. This spend category cannot be tracked in Business Assets   
 
Items_Reference  Item_DescriptorObject  [0..*]  Reference to existing item to which the asset pooling rule applies. 
Validation Description
One or more items is invalid because it does not belong to a trackable Spend Category.   
 
Currency_Reference  CurrencyObject  [0..1]  Reference to an existing currency to which the asset pooling rule applies. This is required if Less Than Amount is specified. 
Validation Description
Currency is required when Unit Cost Less Than is specified.   
 
Quantity_Greater_Than  decimal (22, 2)   [1..1]  The quantity above which the asset pooling rule applies. Quantity must be greater than zero. 
Validation Description
Quantity must be greater than zero.   
The amount entered has too many digits beyond the decimal point.   
 
Unit_Cost_Threshold  decimal (26, 6)   [0..1]  The amount below which the asset pooling rule applies. 
Validation Description
Unit Cost cannot be negative   
 
Validation Description
Either Spend Category or Item must be specified.   
Use another ID for the Asset Pooling Rule or unset the Add Only attribute. An Asset Pooling Rule Rule already exists for the ID [ID].  The Put Asset Pooling Rule web service cannot be used to edit an existing rule; it can only add rules, or replace all rules. 
Rule order must be unique.   
top
 

OrganizationObject

part of: Asset_Pooling_Rule_Replacement_Data
 
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  OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_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_Category_or_HierarchyObject

part of: Asset_Pooling_Rule_Replacement_Data
 
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_Category_or_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Spend_Category_or_HierarchyObjectID

part of: Spend_Category_or_HierarchyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Resource_Category_Hierarchy_ID, 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
 

Item_DescriptorObject

part of: Asset_Pooling_Rule_Replacement_Data
 
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  Item_DescriptorObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Item_DescriptorObjectID

part of: Item_DescriptorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Catalog_Item_ID, Catalog_Load_Item_ID, Expense_Item_ID, Purchase_Item_ID, Sales_Item_ID, Supplier_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
 

CurrencyObject

part of: Asset_Pooling_Rule_Replacement_Data
 
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  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [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
 

Asset_Pooling_RuleReferenceEnumeration

part of: Asset_Pooling_RuleObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Spend_Category_or_HierarchyReferenceEnumeration

part of: Spend_Category_or_HierarchyObjectID
Base Type
string
top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top