Service Directory > v31.2 > Resource_Management > Get_Requirements_for_Resource_Plan
 

Operation: Get_Requirements_for_Resource_Plan

The Web service operation retrieves Resource Requirements.


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

Documentation Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Resource_Plan_Request_References  [0..1]  Request Element   
Request_Criteria [Choice]   Resource_Plan_Request_Criteria  [0..1]   
Response_Filter  Response_Filter  [0..1] 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Resource_Plan_Response_Group  [0..1]   
top
 

Response Element: Get_Requirements_for_Resource_Plan_Response

Documentation Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Resource_Plan_Request_References  [0..*]  Resource Plan Request Reference   
Request_Criteria  Resource_Plan_Request_Criteria  [0..*]  Request Criteria   
Response_Filter  Response_Filter  [0..*]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Resource_Plan_Response_Group  [0..*]  Response Group   
Response_Results  Response_Results  [0..*]  Response Results   
Response_Data  Resource_Requirements_Response_Data  [0..*]  Resource Requirements Response Data   
top
 

Resource_Plan_Request_References

part of: Get_Requirements_for_Resource_Plan_Request, Get_Requirements_for_Resource_Plan_Response
.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Plan_Reference  Project_Resource_PlanObject  [0..*]  Resource Plan Reference for which Get WWS should run   
top
 

Project_Resource_PlanObject

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

Project_Resource_PlanObjectID

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

part of: Get_Requirements_for_Resource_Plan_Request, Get_Requirements_for_Resource_Plan_Response
Shared Element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Requirements_for_Resource_Plan_Request, Get_Requirements_for_Resource_Plan_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
 

Resource_Plan_Response_Group

part of: Get_Requirements_for_Resource_Plan_Request, Get_Requirements_for_Resource_Plan_Response
.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Resource_Requirements_Response_Data

part of: Get_Requirements_for_Resource_Plan_Response
.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Plan_Requirement  Resource_Plan_for_Requirements  [0..*]  .Resource Plan   
top
 

Resource_Plan_for_Requirements

part of: Resource_Requirements_Response_Data
Element containing Requirement(s) from Resource Plan(s) elements including Parameter , reference field (CRF) and Instance values.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Plan_Reference  Project_Resource_PlanObject  [0..1]  Resource Plan Reference   
Resource_Plan_Requirement_Data  Resource_Plan_Requirement_Data  [0..*]  Resource Plan Requirement Data   
top
 

Resource_Plan_Requirement_Data

part of: Resource_Plan_for_Requirements
new web service
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]   
Resource_Plan_ID  string  [0..1]  Resource Plan ID   
Resource_Plan_Line_Requirement_Data  Resource_Plan_Line_Requirement_Data  [0..*] 
Validation Description
The Incoming Category ID must match the Category ID of the Resource Plan Line used. You can’t replace or delete the Category ID of a Resource Plan Line that has an existing category.   
You can’t have a blank requirements row. [reqID]   
Update your selection by changing either the Category or the Optional setting. You can't duplicate this combination.   
 
top
 

Resource_Plan_Line_Requirement_Data

part of: Resource_Plan_Requirement_Data
Resource Plan Line Requirement Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Delete   
Resource_Plan_Line_Requirement_ID  string  [0..1]  Resource Plan Line Requirement ID   
Resource_Plan_Detail_Reference  Project_Resource_Plan_DetailObject  [1..1]  Resource Plan Detail Reference 
Validation Description
Detail Data is not valid for the specified Project Resource Plan. Please specify a new Detail ID or Project Resource Plan. (Detail ID: [detail])   
Project Resource Plan Detail Webservice MLV Criticals   
 
Resource_Plan_Line_Requirement_Parameter_Data  Resource_Plan_Requirement_Parameter_Data  [0..*]  Resource Plan Requirement Parameter Data 
Validation Description
Either delete the Category or enter a value for the Category and a corresponding Requirement. You can’t have a blank or empty Category or Requirement.   
Enter a valid Category report field. The Category you entered isn’t valid. [crf]   
You can’t have a blank requirements row.   
The Parameter ID is not valid for this Project Resource Requirement. Specify a new Parameter ID or a different Project Resource Requirement. (Parameter ID: [paramID])   
Enter a valid Requirement. The Requirement you entered isn’t valid for this Category. Category=[crf WID]   
Update your selection. You can't duplicate Requirements.   
[crf] cannot have multiple entries.   
 
Validation Description
The Incoming Category ID must match the Category ID of the Resource Plan Line used. You can’t replace or delete the Category ID of a Resource Plan Line that has an existing category.   
You can’t have a blank requirements row. [reqID]   
Update your selection by changing either the Category or the Optional setting. You can't duplicate this combination.   
top
 

Project_Resource_Plan_DetailObject

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

Project_Resource_Plan_DetailObjectID

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

part of: Resource_Plan_Line_Requirement_Data
Resource Plan requirement Data sub element
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Delete   
Resource_Plan_Line_Requirement_Parameter_ID  string  [0..1]   
Requirement_Field_Reference  External_FieldObject  [0..1]   
Requirement_Value_Reference  InstanceObject  [0..*]   
Optional_Requirement_Indicator  boolean  [0..1]  Optional Requirement   
Validation Description
Either delete the Category or enter a value for the Category and a corresponding Requirement. You can’t have a blank or empty Category or Requirement.   
Enter a valid Category report field. The Category you entered isn’t valid. [crf]   
You can’t have a blank requirements row.   
The Parameter ID is not valid for this Project Resource Requirement. Specify a new Parameter ID or a different Project Resource Requirement. (Parameter ID: [paramID])   
Enter a valid Requirement. The Requirement you entered isn’t valid for this Category. Category=[crf WID]   
Update your selection. You can't duplicate Requirements.   
[crf] cannot have multiple entries.   
top
 

External_FieldObject

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

External_FieldObjectID

part of: External_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Calculated_Field_ID, Computed_Data_Source_Field_ID, Custom_Field_Data_Set_ID, Custom_Field_ID, Extension_Computed_Data_Field_Reference_ID, External_Analytics_Data_Source_Field_ID, WCP_Component_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
 

InstanceObject

part of: Resource_Plan_Requirement_Parameter_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Project_Resource_PlanReferenceEnumeration

part of: Project_Resource_PlanObjectID
Base Type
string
top
 

Project_Resource_Plan_DetailReferenceEnumeration

part of: Project_Resource_Plan_DetailObjectID
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
top