Service Directory > v32.1 > Resource_Management > Submit_Project_Scenario
 

Operation: Submit_Project_Scenario

Web service used to submit Project Scenarios.


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

Request element for Submitting a Project Scenario via a Web Service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Project_Scenario_Reference  Project_ScenarioObject  [0..1]  Reference to an existing Project Scenario for update only purposes.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Business Process Parameters provide the ability to auto-submit to the business process.   
Project_Scenario_Data  Project_Scenario_Data  [0..1]  Element containing Project Scenario data to be retrieved or input via web service. 
Validation Description
The End Date must be greater than the Start Date.   
The project scenario group cannot be changed for an existing project scenario. Specify the scenario group currently related to the scenario: [persisted scenario group]   
 
Validation Description
The Web Service is set to Add Only; but the Project Scenario already exists.   
The Project Scenario Name matches the name of another project scenario in this project scenario group. Change the Project Scenario Name to be unique within the scenario group.   
The Project Scenario must be In Progress to submit.   
top
 

Response Element: Submit_Project_Scenario_Response

Response after Submitting a Project Scenario.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Project_Scenario_Reference  Project_ScenarioObject  [0..1]  Project Scenario Reference   
top
 

Project_ScenarioObject

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

Project_ScenarioObjectID

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

Financials_Business_Process_Parameters

part of: Submit_Project_Scenario_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, Project_Scenario_Assignment_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_Scenario_Data

part of: Submit_Project_Scenario_Request
Element containing Project Scenario data to be retrieved or input via web service.
 
Parameter name Type/Value Cardinality Description Validations
Project_Scenario_Reference_ID  string  [0..1]  Reference ID for the Project Scenario.   
Project_Scenario_Status_Reference  Document_StatusObject  [0..1]  READ ONLY: Status of the Project Scenario.   
Project_Scenario_Name  string  [1..1]  Free form text field for a meaningful Project Scenario Name - this is required for creating a project scenario.   
Project_Scenario_Group_Reference  Project_Scenario_GroupObject  [1..1]  Project Scenario Group that the Project Scenario is related to - this is required for creating a project scenario.   
Start_Date  date  [1..1]  Start date of the project scenario - this is required for creating a project scenario.   
End_Date  date  [0..1]  End date of the project scenario.   
Time_Unit_for_Effort_Reference  Unit_of_TimeObject  [0..1]  Reference to the unit of time in which the calculated effort will be displayed on the project scenario. Defaults to the hours unit of time if no value is provided.   
Description  string  [0..1]  Free form text field containing the description of the project scenario.   
Currency_Reference  CurrencyObject  [0..1]  Reference to the required currency for all amounts on the project scenario. Defaults to the currency from the associated project hierarchy, or the preferred currency of the worker submitting the web service, or the tenant currency if no value is provided. 
Validation Description
Currency is required.   
 
Spend  decimal (26, 6) >0   [0..1]  Numeric amount indicating the spend of the project scenario. Currency of the amount is determined by the currency reference on the project scenario.   
Manual_Budget  decimal (26, 6) >0   [0..1]  Numeric amount indicating the manual budget of the project scenario. Currency of the amount is determined by the currency reference on the project scenario.   
Revenue_Savings  decimal (26, 6) >0   [0..1]  Numeric amount indicating the revenue/savings of the project scenario. Currency of the amount is determined by the currency reference on the project scenario.   
Plan_Task_Data  Project_Scenario_Plan_Task_Data  [0..*]  Wrapper element for Project Scenario Plan Task Data containing references to phases and tasks. 
Validation Description
Task End Date cannot be after the Project Scenario End Date.   
Task End Date cannot be before the Project Scenario Start Date.   
Task End Date cannot be before the Task Start Date.   
Task Start Date cannot be after Project Scenario End Date.   
Task Start Date cannot be before Project Scenario Start Date.   
 
Validation Description
The End Date must be greater than the Start Date.   
The project scenario group cannot be changed for an existing project scenario. Specify the scenario group currently related to the scenario: [persisted scenario group]   
top
 

Document_StatusObject

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

Document_StatusObjectID

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

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

Project_Scenario_GroupObjectID

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

Unit_of_TimeObject

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

Unit_of_TimeObjectID

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

CurrencyObject

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

CurrencyObjectID

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

part of: Project_Scenario_Data
Element containing project scenario plan task data.
 
Parameter name Type/Value Cardinality Description Validations
Plan_Task_ID  string  [0..1]  Plan Task ID. This is the unique identifier for the task specific to the project scenario.   
Order  string (5)   [0..1]  Specifies the display order of the task in the project scenario plan.   
Phase_Reference  Project_PhaseObject  [1..1]  Reference to the globally unique phase name data shared across projects and scenarios.   
Task_Reference  Project_TaskObject  [1..1]  Reference to the globally unique task name data shared across projects and scenarios.   
Start_Date  date  [0..1]  Task start date. This date should be entered without time precision (e.g., 2009-01-01).   
End_Date  date  [0..1]  Task end date. This date should be entered without time precision (e.g., 2009-01-01).   
Estimated_Effort  decimal (10, 0) >0   [0..1]  Estimated effort in hours for the entire plan task.   
Calculated_Effort  decimal (13, 3) >0   [0..1]  READ ONLY: Calculated effort for all assignments in the scenario plan task in the unit of time specified on the scenario.   
Assignment_Data  Project_Scenario_Assignment_Data  [0..*]  Element containing project scenario assignment data. 
Validation Description
Worker and To Be Hired cannot both be specified for assignment.   
Assignment Start Date cannot be before Task Start Date.   
Assignment Start Date cannot be after Task End Date.   
Assignment End Date cannot be before Assignment Start Date.   
Assignment End Date cannot be after Task End Date.   
Assignment End Date cannot be before Task Start Date.   
Assignment Start Date cannot be before Scenario Start Date.   
Assignment End Date cannot be before Scenario Start Date.   
Assignment Start Date cannot be after Scenario End Date.   
Assignment End Date cannot be after Scenario End Date.   
Worker is not valid for the selected Job Profile. (Worker: [worker], Job Profile: [profile])   
 
Validation Description
Task End Date cannot be after the Project Scenario End Date.   
Task End Date cannot be before the Project Scenario Start Date.   
Task End Date cannot be before the Task Start Date.   
Task Start Date cannot be after Project Scenario End Date.   
Task Start Date cannot be before Project Scenario Start Date.   
top
 

Project_PhaseObject

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

Project_PhaseObjectID

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

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

Project_TaskObjectID

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

part of: Project_Scenario_Plan_Task_Data
Element containing project scenario assignment data.
 
Parameter name Type/Value Cardinality Description Validations
Assignment_ID  string  [0..1]  Assignment ID. This is the unique identifier for the assignment specific to the task.   
Order  string  [0..1]  Specifies the display order of the assignments in the project scenario plan task.   
Job_Profile_Reference  Job_ProfileObject  [1..1]  Reference to the job profile for the scenario assignment.   
Worker_Reference  WorkerObject  [0..1]  Reference to the worker for the scenario assignment.   
To_Be_Hired  boolean  [0..1]  Boolean value indicating whether the a worker is to be hired to fulfill the assignment.   
Assignment_Start_Date  date  [0..1]  Assignment Start Date. This date should be entered without time precision (e.g., 2009-01-01).   
Assignment_End_Date  date  [0..1]  Assignment End Date. This date should be entered without time precision (e.g., 2009-01-01).   
Calculated_Effort  decimal (13, 3) >0   [0..1]  READ ONLY: Calculated effort for the assignment in the unit of time specified on the scenario.   
Validation Description
Worker and To Be Hired cannot both be specified for assignment.   
Assignment Start Date cannot be before Task Start Date.   
Assignment Start Date cannot be after Task End Date.   
Assignment End Date cannot be before Assignment Start Date.   
Assignment End Date cannot be after Task End Date.   
Assignment End Date cannot be before Task Start Date.   
Assignment Start Date cannot be before Scenario Start Date.   
Assignment End Date cannot be before Scenario Start Date.   
Assignment Start Date cannot be after Scenario End Date.   
Assignment End Date cannot be after Scenario End Date.   
Worker is not valid for the selected Job Profile. (Worker: [worker], Job Profile: [profile])   
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

part of: Project_ScenarioObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Project_Scenario_GroupReferenceEnumeration

part of: Project_Scenario_GroupObjectID
Base Type
string
top
 

Unit_of_TimeReferenceEnumeration

part of: Unit_of_TimeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Project_PhaseReferenceEnumeration

part of: Project_PhaseObjectID
Base Type
string
top
 

Project_TaskReferenceEnumeration

part of: Project_TaskObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top