Service Directory > v33.1 > Resource_Management > Get_Purchase_Order_Lines_Additional_Data
 

Operation: Get_Purchase_Order_Lines_Additional_Data

Enable retrieval of custom objects for the purchase order line.


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

The Get Purchase Order Lines Additional Data Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Purchase_Order_Line_Additional_Data_Request_References  [0..1]  This element contains the specific instance set containing the requested purchase order line. The type attribute is either Reference ID type or Workday ID (GUI) and the ID is the value for the instance of the purchase order line.   
Request_Criteria [Choice]   Purchase_Order_Line_Additional_Data_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the purchase order-specific criteria   
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  Purchase_Order_Line_Additional_Data_Response_Group  [0..1]  Get Purchase Order Line Response Group   
top
 

Response Element: Get_Purchase_Order_Lines_Additional_Data_Response

The Get Purchase Order Lines Additional Data Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Purchase_Order_Line_Additional_Data_Request_References  [0..1]  The Purchase Order Line Additional Data Request References element   
Request_Criteria  Purchase_Order_Line_Additional_Data_Request_Criteria  [0..1]  The Purchase Order Line Additional Data Request References element   
Response_Filter  Response_Filter  [0..1]  The Response Filter element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Purchase_Order_Line_Additional_Data_Response_Group  [0..1]  The Purchase Order Line Additional Data Response Group element   
Response_Results  Response_Results  [0..1]  The Response Results element   
Response_Data  Purchase_Order_Line_Additional_Data_Response_Data  [0..1]  The Purchase Order Line Additional Data Response Data element   
top
 

Purchase_Order_Line_Additional_Data_Request_References

part of: Get_Purchase_Order_Lines_Additional_Data_Request, Get_Purchase_Order_Lines_Additional_Data_Response
This element contains the specific instance set containing the requested purchase order line. The type attribute is either Reference ID type or Workday ID (GUI) and the ID is the value for the instance of the purchase order line.
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Order_Line_Reference  Purchase_Order_LineObject  [1..*]  The purchase order line reference   
top
 

Purchase_Order_LineObject

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

Purchase_Order_LineObjectID

part of: Purchase_Order_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Line_Number, Purchase_Order_Line_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Change_Order_Reference_ID, Document_Number, Purchase_Order_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Purchase_Order_Line_Additional_Data_Request_Criteria

part of: Get_Purchase_Order_Lines_Additional_Data_Request, Get_Purchase_Order_Lines_Additional_Data_Response
This element is the wrapper around a list of elements representing the purchase order-specific criteria
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Order_Reference  Purchase_OrderObject  [1..*]  The purchase order reference   
top
 

Purchase_OrderObject

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

Purchase_OrderObjectID

part of: Purchase_OrderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Number, Purchase_Order_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Order_Type_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Response_Filter

part of: Get_Purchase_Order_Lines_Additional_Data_Request, Get_Purchase_Order_Lines_Additional_Data_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Purchase_Order_Line_Additional_Data_Response_Group

part of: Get_Purchase_Order_Lines_Additional_Data_Request, Get_Purchase_Order_Lines_Additional_Data_Response
Get Purchase Order Line Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Purchase_Order_Lines_Additional_Data_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Purchase_Order_Line_Additional_Data_Response_Data

part of: Get_Purchase_Order_Lines_Additional_Data_Response
The Purchase Order Line Additional Data Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Order_Line_Additional_Data  Purchase_Order_Line_Additional_Data  [0..*]  The Purchase Order Line reference   
top
 

Purchase_Order_Line_Additional_Data

part of: Purchase_Order_Line_Additional_Data_Response_Data
Wrapper element containing the Purchase Order Line additional data for requested references or criteria, and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Order_Line_Additional_Data_Reference  Purchase_Order_LineObject  [0..1]  The purchase order line reference   
Business_Object_Additional_Data  Non_Effective_Dated_Web_Service_Additional_Data  [0..1]  Non Effective Dated Web Service Additional Data   
top
 

Non_Effective_Dated_Web_Service_Additional_Data

part of: Purchase_Order_Line_Additional_Data
Non Effective Dated Web Service Additional Data
 
Parameter name Type/Value Cardinality Description Validations
top
 

Purchase_Order_LineReferenceEnumeration

part of: Purchase_Order_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Purchase_OrderReferenceEnumeration

part of: Purchase_OrderObjectID
Base Type
string
top
 

Base Type
string

top