Service Directory > v32.1 > Resource_Management > Import_Resource_Forecast
 

Operation: Import_Resource_Forecast

This background service operation will add, update Resource Forecasts. This import is Asynchronous and the response will only be an acknowledgement or receipt. Resource Forecast data includes Project to which Resource Forecast is created for, Worker and Project role for Resource Forecast Line and Forecasted Hours and Start Date of the forecast. This web service also provides the ability to replace all Resource Forecast for a Project, Replace all or Delete Resource Forecast Lines and Delete Resource Forecast Line Allocation.


@ - 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: Import_Resource_Forecast_Request

This element is starting element for Import Resource Forecast High Volume Web Service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only flag   
Resource_Forecast_Reference  Resource_ForecastObject  [0..1]  Resource Forecast Reference   
Resource_Forecast_Data  Resource_Forecast__HV__Data  [1..1]  Resource Forecast Header Data 
Validation Description
A resource forecast already exists for this project: [project] .   
You must assign a resource plan to this project before creating a resource Forecast: [project].   
You can’t change the project for this existing resource forecast: [resource forecast]   
Cannot update Resource Forecast which is not current :[resource forecast]   
You must create a resource forecast configuration when you create a new resource forecast.   
 
Validation Description
The Web Service is set to Add Only; documents cannot be resubmitted.  The Web Service is set to Add Only; documents cannot be resubmitted. 
Web service is set to AddOnly false, cannot create a new Resource Forecast.  Web service is set to AddOnly false, cannot create a new Resource Forecast. 
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Resource_ForecastObject

part of: Import_Resource_Forecast_Request
 
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__HV__Data

part of: Import_Resource_Forecast_Request
Element for Import Resource Forecast High Volume Web Service. This element represents header (Resource Forecast) data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  If Replace All is set to True, a full sync will be performed once the web service is submitted.   
Resource_Forecast_ID  string  [0..1]  Resource Forecast ID   
Project_Reference  ProjectObject  [1..1]  Project Reference   
Resource_Forecast_Configuration_Data  Resource_Forecast_Configuration_Data  [0..*]  Resource Forecast Configuration Data 
Validation Description
Set forecast level to either project or task, but not both.   
Do not change resource forecast configuration forecast level during update.   
Set forecast source to percent allocation or estimated hours, but not both.   
Do not change resource forecast configuration forecast source during update.   
Set the forecast frequency to either day, week, or month.   
Do not change resource forecast configuration forecast frequency during update.   
Set Forecast Hours to Decimal or Whole, but not both.   
Don’t change the resource forecast configuration for whole numbers or decimals during the update.   
 
Resource_Forecast_Line_Data  Resource_Forecast_Line__HV__Data  [0..*]  Resource Forecast Line Data 
Validation Description
The resource forecast for this existing resource forecast line can’t be changed.   
Cannot pass Resource Forecast Line Reference when Replace All Flag is selected : [Resource Forecast Line]   
The field task is required and must have a value.   
The resource forecast level view is set to project, remove the task from the resource forecast line.   
This project resource[ppt] and resource plan line are not valid for the resource plan: [project resource], [rpl][task].   
 
Validation Description
A resource forecast already exists for this project: [project] .   
You must assign a resource plan to this project before creating a resource Forecast: [project].   
You can’t change the project for this existing resource forecast: [resource forecast]   
Cannot update Resource Forecast which is not current :[resource forecast]   
You must create a resource forecast configuration when you create a new resource forecast.   
top
 

ProjectObject

part of: Resource_Forecast__HV__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  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_Data

part of: Resource_Forecast__HV__Data
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_Month  boolean  [0..1]  Boolean representing Forecast Frequency Month.   
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   
Forecast_Hours_Whole  boolean  [0..1]  Boolean representing Forecast Whole Number.   
Forecast_Hours_Decimal  boolean  [0..1]  Boolean representing Forecast Decimal.   
Validation Description
Set forecast level to either project or task, but not both.   
Do not change resource forecast configuration forecast level during update.   
Set forecast source to percent allocation or estimated hours, but not both.   
Do not change resource forecast configuration forecast source during update.   
Set the forecast frequency to either day, week, or month.   
Do not change resource forecast configuration forecast frequency during update.   
Set Forecast Hours to Decimal or Whole, but not both.   
Don’t change the resource forecast configuration for whole numbers or decimals during the update.   
top
 

Resource_Forecast_Line__HV__Data

part of: Resource_Forecast__HV__Data
Resource Forecast Line Data element for Import Resource Forecast High Volume Web Service.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Delete Flag   
Resource_Forecast_Line_Reference  Resource_Forecast_LineObject  [0..1]  Resource Forecast Line Reference   
Resource_Forecast_Line_ID  string  [0..1]  Resource Forecast Line ID   
Project_Resource_Reference  Project_ResourceObject  [1..1]  Project Resource for Resource Forecast Line   
Resource_Plan_Line_Reference  Project_Resource_Plan_DetailObject  [1..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__HV__Data  [0..*]  Weekly Allocation Data element for Resource Forecast Line 
Validation Description
This period start date is a duplicate: [date]   
Forecasted Hours cannot be empty.   
For the weekly configuration, you must use a Monday for the period start date: [period start date].   
For the daily configuration, you must use a weekday for the period start date: [period start date].   
For the monthly configuration, use the first day of the month for the period start date: [period start date].   
 
Validation Description
The resource forecast for this existing resource forecast line can’t be changed.   
Cannot pass Resource Forecast Line Reference when Replace All Flag is selected : [Resource Forecast Line]   
The field task is required and must have a value.   
The resource forecast level view is set to project, remove the task from the resource forecast line.   
This project resource[ppt] and resource plan line are not valid for the resource plan: [project resource], [rpl][task].   
top
 

Resource_Forecast_LineObject

part of: Resource_Forecast_Line__HV__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  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__HV__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_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__HV__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
 

Project_Plan_TaskObject

part of: Resource_Forecast_Line__HV__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_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__HV__Data

part of: Resource_Forecast_Line__HV__Data
Weekly Allocation Data for Resource Forecast Line
 
Parameter name Type/Value Cardinality Description Validations
Period_Start_Date  date  [1..1]  Period start date for weekly allocation data   
Forecasted_Hours  decimal (5, 2) >0   [0..1]  Forecasted hours for weekly allocation data   
Validation Description
This period start date is a duplicate: [date]   
Forecasted Hours cannot be empty.   
For the weekly configuration, you must use a Monday for the period start date: [period start date].   
For the daily configuration, you must use a weekday for the period start date: [period start date].   
For the monthly configuration, use the first day of the month for the period start date: [period start date].   
top
 

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

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
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top