Service Directory > v25.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]   
 
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. 
Enhanced Resource Management tenant flag should be enabled before using this Web Service.  Enhanced Resource Management tenant flag should be enabled before using this Web Service. 
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_Line_Data  Resource_Forecast_Line__HV__Data  [0..*]  Resource Forecast Line Data 
Validation Description
You must add this worker to the resource plan before the worker can be included on the resource forecast: [worker].   
This project role is not valid for the worker on the resource plan : [project role]   
This worker and project role are not valid for the resource plan line: [worker], [role].   
The resource forecast for this existing resource forecast line can’t be changed.   
Resource Forecast Line ID [ID] already exists.   
Cannot pass Resource Forecast Line Reference when Replace All Flag is selected : [Resource Forecast Line]   
 
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]   
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_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   
Worker_Reference  WorkerObject  [1..1]  Worker for Resource Forecast Line   
Project_Role_Reference  Project_RoleObject  [1..1]  Project role 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
Please provide correct date.[period start date]. The period start date must begin on a Monday.   
Enter a whole number for the forecasted hours: [Forecasted Hours] for this period start date: [period start date].   
This period start date is a duplicate: [date]   
Forecasted Hours cannot be empty.   
 
Validation Description
You must add this worker to the resource plan before the worker can be included on the resource forecast: [worker].   
This project role is not valid for the worker on the resource plan : [project role]   
This worker and project role are not valid for the resource plan line: [worker], [role].   
The resource forecast for this existing resource forecast line can’t be changed.   
Resource Forecast Line ID [ID] already exists.   
Cannot pass Resource Forecast Line Reference when Replace All Flag is selected : [Resource Forecast Line]   
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
 

WorkerObject

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

WorkerObjectID

part of: WorkerObject
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  [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_RoleObject

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

Project_RoleObjectID

part of: Project_RoleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Project_Worker_Role_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
Please provide correct date.[period start date]. The period start date must begin on a Monday.   
Enter a whole number for the forecasted hours: [Forecasted Hours] for this period start date: [period start date].   
This period start date is a duplicate: [date]   
Forecasted Hours cannot be empty.   
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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Project_RoleReferenceEnumeration

part of: Project_RoleObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top