Service Directory > v31.2 > Resource_Management > Get_Purchase_Item_Groups
 

Operation: Get_Purchase_Item_Groups

This service operation will get Purchase Item Groups for the specified criteria. Purchase Items groups can be used to make it easier to search for and select items. Purchase items can belong to multiple groups. Purchase Item Group data includes Purchase Item Group ID and Name. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


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

Contains request reference, criteria, filter and response group for getting Purchase Item Group data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Purchase_Item_Group_Request_References  [0..1]  Get Purchase Item Groups Request References   
Request_Criteria [Choice]   Purchase_Item_Group_Request_Criteria  [0..1]  Get Purchase Item Groups   
Response_Filter  Response_Filter  [0..1]  Get Purchase Item Groups 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Purchase_Item_Group_Response_Group  [0..1]  Get Purchase Item Groups   
top
 

Response Element: Get_Purchase_Item_Groups_Response

Element containing Purchase Item Group response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Purchase_Item_Group_Request_References  [0..1]  Get Purchase Item Groups Request References   
Request_Criteria  Purchase_Item_Group_Request_Criteria  [0..1]  Get Purchase Item Groups Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Purchase Item Groups Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Purchase_Item_Group_Response_Group  [0..1]  Get Purchase Item Groups Response Group   
Response_Results  Response_Results  [0..1]  Get Purchase Item Groups Response Results   
Response_Data  Purchase_Item_Group_Response_Data  [0..1]  Get Purchase Item Groups Response Data   
top
 

Purchase_Item_Group_Request_References

part of: Get_Purchase_Item_Groups_Request, Get_Purchase_Item_Groups_Response
Element containing reference instances for a Purchase Item Group
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Item_Group_Reference  Purchase_Item_GroupObject  [1..*]  Reference to an existing Purchase Item Group   
top
 

Purchase_Item_GroupObject

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

Purchase_Item_GroupObjectID

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

part of: Get_Purchase_Item_Groups_Request, Get_Purchase_Item_Groups_Response
Element containing Purchase Item Group request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Purchase_Item_Groups_Request, Get_Purchase_Item_Groups_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
 

Purchase_Item_Group_Response_Group

part of: Get_Purchase_Item_Groups_Request, Get_Purchase_Item_Groups_Response
Element containing Purchase Item Group response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Purchase_Item_Group_Response_Data

part of: Get_Purchase_Item_Groups_Response
Wrapper Element that includes Purchase Item Group Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Item_Group  Purchase_Item_Group  [0..*]  Purchase Item Group   
top
 

Purchase_Item_Group

part of: Purchase_Item_Group_Response_Data
Wrapper Element that includes Purchase Item Group Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Item_Group_Reference  Purchase_Item_GroupObject  [0..1]  Reference to an existing Purchase Item Group   
Purchase_Item_Group_Data  Purchase_Item_Group_Data  [0..1]  Purchase Item Group Data   
top
 

Purchase_Item_Group_Data

part of: Purchase_Item_Group
Element containing all Purchase Item Group data
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Item_Group_ID  string  [0..1]  Purchase Item Group ID. This is the Purchase Item Group unique identifier   
Purchase_Item_Group_Name  string  [1..1]  Free form text field for a meaningful Purchase Item Group Name 
Validation Description
Enter a unique Item Group Name. [name] is already in use.  The Item Group Name is already in use. 
 
top
 

Purchase_Item_GroupReferenceEnumeration

part of: Purchase_Item_GroupObjectID
Base Type
string
top