Service Directory > v31.2 > Resource_Management > Put_Project_Scenario_Group
 

Operation: Put_Project_Scenario_Group

Web service used to put Project Scenario Groups.


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

Request element for Putting a Project Scenario Group 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_Group_Reference  Project_Scenario_GroupObject  [0..1]  Reference to an existing Project Scenario Group for update only purposes.   
Project_Scenario_Group_Data  Project_Scenario_Group_Data  [0..1]  Element containing Project Scenario Group data to be retrieved or input via web service. 
Validation Description
The project hierarchy cannot be changed for an existing project scenario group. Specify the hierarchy currently related to the scenario group: [persisted hierarchy]   
The primary project scenario specified is not in the list of available project scenarios. Specify a primary scenario from the list of available project scenarios for this project scenario group.   
The Project Hierarchy is not in an approved status. You cannot create a Project Scenario Group for a Project Hierarchy that is In Progress, Denied, Canceled and so forth.   
You cannot create a Project Scenario Group for a Project Hierarchy that is inactive.   
 
Validation Description
The Web Service is set to Add Only; but the Project Scenario Group already exists.   
The Project Scenario Group Name matches the name of another project scenario group in this project hierarchy. Change the Project Scenario Group Name to be unique within the hierarchy.   
top
 

Response Element: Put_Project_Scenario_Group_Response

Response after Putting a Project Scenario Group.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Project_Scenario_Group_Reference  Project_Scenario_GroupObject  [0..1]  Project Scenario Group Reference   
top
 

Project_Scenario_GroupObject

part of: Put_Project_Scenario_Group_Request, Put_Project_Scenario_Group_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_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
 

Project_Scenario_Group_Data

part of: Put_Project_Scenario_Group_Request
Element containing Project Scenario Group data to be retrieved or input via web service.
 
Parameter name Type/Value Cardinality Description Validations
Project_Scenario_Group_Reference_ID  string  [0..1]  Reference ID for the Project Scenario Group.   
Project_Scenario_Group_Name  string  [1..1]  Free form text field for a meaningful Project Scenario Group Name   
Project_Hierarchy_Reference  Project_HierarchyObject  [1..1]  Project Hierarchy that the Project Scenario Group is related to - this is required for creating a project scenario group.   
Initiative_Reference  InitiativeObject  [0..1]  Initiative that the Project Scenario Group is related to.   
Primary_Project_Scenario_Reference  Project_ScenarioObject  [0..1]  Project Scenario that is considered the primary scenario for this Project Scenario Group.   
Available_Project_Scenarios_Reference  Project_ScenarioObject  [0..*]  READ ONLY: Project Scenarios that belong to this Project Scenario Group.   
Validation Description
The project hierarchy cannot be changed for an existing project scenario group. Specify the hierarchy currently related to the scenario group: [persisted hierarchy]   
The primary project scenario specified is not in the list of available project scenarios. Specify a primary scenario from the list of available project scenarios for this project scenario group.   
The Project Hierarchy is not in an approved status. You cannot create a Project Scenario Group for a Project Hierarchy that is In Progress, Denied, Canceled and so forth.   
You cannot create a Project Scenario Group for a Project Hierarchy that is inactive.   
top
 

Project_HierarchyObject

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

Project_HierarchyObjectID

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

InitiativeObject

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

InitiativeObjectID

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

part of: Project_Scenario_Group_Data, Project_Scenario_Group_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_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
 

Project_Scenario_GroupReferenceEnumeration

part of: Project_Scenario_GroupObjectID
Base Type
string
top
 

Project_HierarchyReferenceEnumeration

part of: Project_HierarchyObjectID
Base Type
string
top
 

InitiativeReferenceEnumeration

part of: InitiativeObjectID
Base Type
string
top
 

Project_ScenarioReferenceEnumeration

part of: Project_ScenarioObjectID
Base Type
string
top