Service Directory > v31.2 > Resource_Management > Get_Resource_Forecasts
 

Operation: Get_Resource_Forecasts

This GET Web Service retrieves Resource Forecast based on Resource Forecast Reference ID or Project ID passed in as request criteria


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

Root element for the Request on the Get operation. Contains references, criteria, filter and response group for specifying which instances to return in the Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Resource_Forecast_Request_References  [0..1]  This Element contains Resource Forecast Request References for which Resource Forecast should be retrieved   
Request_Criteria [Choice]   Resource_Forecast_Request_Criteria  [0..1]  This Element Contains Project ID for which Resource Forecast should be retrieved   
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  Resource_Forecast_Response_Group  [0..1]  Resource Forecast Request Criteria Response Group   
top
 

Response Element: Get_Resource_Forecasts_Response

This element contains Resource Forecast Details including Resource Forecast Lines and Resource Forecast Allocations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Resource_Forecast_Request_References  [0..1]  Resource Forecast Request References element for Get Resource Forecast web service   
Request_Criteria  Resource_Forecast_Request_Criteria  [0..1]  Resource Forecast Request Criteria element for Get Resource Forecast Web Service   
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  Resource_Forecast_Response_Group  [0..1]  Resource Forecast Request Criteria Response Group   
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  Resource_Forecast_Response_Data  [0..1]  This element contains Resource Forecast Details including Resource Forecast Lines and Resource Forecast Allocations   
top
 

Resource_Forecast_Request_References

part of: Get_Resource_Forecasts_Request, Get_Resource_Forecasts_Response
Resource Forecast Request References element for Get Resource Forecast web service
 
Parameter name Type/Value Cardinality Description Validations
Resource_Forecast_Reference  Resource_ForecastObject  [1..*]  Resource Forecast Reference   
top
 

Resource_ForecastObject

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

Resource_ForecastObjectID

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

part of: Get_Resource_Forecasts_Request, Get_Resource_Forecasts_Response
Resource Forecast Request Criteria element for Get Resource Forecast Web Service
 
Parameter name Type/Value Cardinality Description Validations
Project_ID  string  [0..1]  Reference ID for the Project   
top
 

Response_Filter

part of: Get_Resource_Forecasts_Request, Get_Resource_Forecasts_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_Forecast_Response_Group

part of: Get_Resource_Forecasts_Request, Get_Resource_Forecasts_Response
Resource Forecast Request Criteria Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference Boolean   
top
 

Response_Results

part of: Get_Resource_Forecasts_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_Forecast_Response_Data

part of: Get_Resource_Forecasts_Response
Get Resource Forecasts Response Element
 
Parameter name Type/Value Cardinality Description Validations
Resource_Forecast_Data  Resource_Forecast  [0..*]  Resource Forecast Element   
top
 

Resource_Forecast

part of: Resource_Forecast_Response_Data
This element contains Resource Forecast Details such as Resource Forecast Lines and Resource Forecast Allocations.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Forecast_ID  string  [0..1]  Resource Forecast ID   
Resource_Forecast_Reference  Resource_ForecastObject  [0..1]  Resource Forecast Reference   
Project_Reference  ProjectObject  [0..1]  Resource Forecast for Project   
Resource_Forecast_Configuration_Data  Resource_Forecast_Configuration_Get_Webservice_Data  [0..*]  Resource Forecast Configuration Data   
Resource_Forecast_Line_Data  Resource_Forecast_Line_View_Get_Webservice  [0..*]  Resource Forecast Line Data   
top
 

ProjectObject

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

ProjectObjectID

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

part of: Resource_Forecast
Resource Forecast Configuration data.
 
Parameter name Type/Value Cardinality Description Validations
Project_Forecast_Level  boolean  [0..1]  Boolean representing Forecast Level Project.   
Task_Forecast_Level  boolean  [0..1]  Boolean representing Forecast Level Task.   
Forecast_Frequency_Day  boolean  [0..1]  Boolean representing Forecast Frequency Day.   
Forecast_Frequency_Week  boolean  [0..1]  Boolean representing Forecast Frequency Week.   
Percent_Allocation_Forecast_Source  boolean  [0..1]  Boolean representing Forecast Source Percent Allocation   
Estimated_hours_Forecast_Source  boolean  [0..1]  Boolean representing Forecast Source Estimated hours   
top
 

Resource_Forecast_Line_View_Get_Webservice

part of: Resource_Forecast
This element contains details about Resource Forecast Lines such as Worker, Project Role and Resource Forecast Line Allocations.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Forecast_Line_ID  string  [0..1]  Resource Forecast Line Identifier   
Resource_Forecast_Line_Reference  Resource_Forecast_LineObject  [0..1]  Resource Forecast Line Instance   
Project_Resource_Reference  Project_ResourceObject  [0..1]  Project Resource for Resource Forecast Line   
Resource_Plan_Line_Reference  Project_Resource_Plan_DetailObject  [0..1]  Resource Plan Line for Resource Forecast Line   
Task_Reference  Project_Plan_TaskObject  [0..1]  Project Plan Task for Resource Forecast Line   
Resource_Forecast_Line_Allocation_Data  Resource_Forecast_Line_Allocation_for_Web_Service  [0..*]  This element contain Resource Forecast Line Allocation Details such as Period Start date for the allocation and Forecasted Hours.   
top
 

Resource_Forecast_LineObject

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

Resource_Forecast_LineObjectID

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

Project_ResourceObject

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

Project_ResourceObjectID

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

Project_Resource_Plan_DetailObject

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

Project_Plan_TaskObject

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

Project_Plan_TaskObjectID

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

part of: Resource_Forecast_Line_View_Get_Webservice
This element contain Resource Forecast Line Allocation Details such as Period Start date for the allocation and Forecasted Hours.
 
Parameter name Type/Value Cardinality Description Validations
Period_Start_Date  date  [0..1]  Period Start Date for Resource Forecast Line Allocation   
Forecasted_Hours  decimal (5, 2) >0   [0..1]  Forecasted Hours for Resource Forecast Line Allocation   
top
 

Resource_ForecastReferenceEnumeration

part of: Resource_ForecastObjectID
Base Type
string
top
 

ProjectReferenceEnumeration

part of: ProjectObjectID
Base Type
string
top
 

Resource_Forecast_LineReferenceEnumeration

part of: Resource_Forecast_LineObjectID
Base Type
string
top
 

Project_ResourceReferenceEnumeration

part of: Project_ResourceObjectID
Base Type
string
top
 

Project_Resource_Plan_DetailReferenceEnumeration

part of: Project_Resource_Plan_DetailObjectID
Base Type
string
top
 

Project_Plan_TaskReferenceEnumeration

part of: Project_Plan_TaskObjectID
Base Type
string
top