Service Directory > v31.2 > Resource_Management > Get_Project_Scenario_Groups
 

Operation: Get_Project_Scenario_Groups

This service operation will get Project Scenario Groups for the specified criteria. The request criteria can be for the following: 1) A single transaction based on Reference 2) A single project hierarchy in which case all project scenario groups for the project hierarchy will be retrieved 3) All project scenario groups can be retrieved if no criteria is specified


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

Get Project Scenario Groups Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Project_Scenario_Group_Request_References  [0..1]  Get Project Scenario Group Request References   
Request_Criteria [Choice]   Project_Scenario_Group_Request_Criteria  [0..1]  Get Project Scenario Group Request References   
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  Project_Scenario_Group_Response_Group  [0..1]  Get Project Scenario Group Response Group   
top
 

Response Element: Get_Project_Scenario_Groups_Response

Get Project Scenario Group Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Scenario_Group_Request_References  [0..1]  Get Project Scenario Group Request References   
Request_Criteria  Project_Scenario_Group_Request_Criteria  [0..1]  Get Project Scenario Group Request References   
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  Project_Scenario_Group_Response_Group  [0..1]  Element containing Project Scenario Group response grouping options   
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  Project_Scenario_Group_Response_Data  [0..1]  Project Scenario Group Response Data   
top
 

Project_Scenario_Group_Request_References

part of: Get_Project_Scenario_Groups_Request, Get_Project_Scenario_Groups_Response
Get Project Scenario Group Request References
 
Parameter name Type/Value Cardinality Description Validations
Project_Scenario_Group_Reference  Project_Scenario_GroupObject  [1..*]  Project Scenario Group Reference   
top
 

Project_Scenario_GroupObject

part of: Project_Scenario_Group_Request_References, Project_Scenario_Group
 
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_Request_Criteria

part of: Get_Project_Scenario_Groups_Request, Get_Project_Scenario_Groups_Response
Request Criteria for Get Project Scenario Groups
 
Parameter name Type/Value Cardinality Description Validations
Project_Hierarchy_Containing_Project_Scenario_Group_Reference  Project_HierarchyObject  [0..*]  The Project Hierarchy for which this Project Scenario Group belongs.   
top
 

Project_HierarchyObject

part of: Project_Scenario_Group_Request_Criteria, 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
 

Response_Filter

part of: Get_Project_Scenario_Groups_Request, Get_Project_Scenario_Groups_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
 

Project_Scenario_Group_Response_Group

part of: Get_Project_Scenario_Groups_Request, Get_Project_Scenario_Groups_Response
Element containing Project Scenario Group response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Project_Scenario_Group_Response_Data

part of: Get_Project_Scenario_Groups_Response
Project Scenario Group Response Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Scenario_Group  Project_Scenario_Group  [0..*]  Wrapper element that includes Project Scenario Group Instance and Data   
top
 

Project_Scenario_Group

part of: Project_Scenario_Group_Response_Data
Wrapper element that includes Project Scenario Group Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Scenario_Group_Reference  Project_Scenario_GroupObject  [0..1]  Reference to an existing Project Scenario Group   
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.   
 
top
 

Project_Scenario_Group_Data

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

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