Service Directory > v31.2 > Resource_Management > Get_Project_Phases
 

Operation: Get_Project_Phases

Get Project Phases based on a specific reference or Project Phase Name criteria.


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

Get Project Phases Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Project_Phase_Request_References  [0..1]  Get Project Phase Request Reference   
Request_Criteria [Choice]   Project_Phase_Request_Criteria  [0..1]  Get Project Phase Request Criteria   
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_Phase_Response_Group  [0..1]  Get Project Phase Response Group   
top
 

Response Element: Get_Project_Phases_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Phase_Request_References  [0..1]  Get Project Phase Request Reference   
Request_Criteria  Project_Phase_Request_Criteria  [0..1]  Get Project Phase Request Criteria   
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_Phase_Response_Group  [0..1]  Get Project Phase Response Group   
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_Phase_Response_Data  [0..1]  Project Phase Response   
top
 

Project_Phase_Request_References

part of: Get_Project_Phases_Request, Get_Project_Phases_Response
The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.
 
Parameter name Type/Value Cardinality Description Validations
Project_Phase_Reference  Project_PhaseObject  [1..*]  Project Phase Reference   
top
 

Project_PhaseObject

part of: Project_Phase_Request_References, Project_Phase
 
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_Phase_Request_Criteria

part of: Get_Project_Phases_Request, Get_Project_Phases_Response
Get Project Phase Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Project_Phase_Name  string  [0..1]  Project Phase Name   
top
 

Response_Filter

part of: Get_Project_Phases_Request, Get_Project_Phases_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_Phase_Response_Group

part of: Get_Project_Phases_Request, Get_Project_Phases_Response
Get Project Phase Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
Include_Project_Phase_Data  boolean  [0..1]  Boolean flag to include Project Phase Data   
top
 

Response_Results

part of: Get_Project_Phases_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_Phase_Response_Data

part of: Get_Project_Phases_Response
Element containing the data requested in the GET Project Plan web service request
 
Parameter name Type/Value Cardinality Description Validations
Project_Phase  Project_Phase  [0..*]  Element wrapping all Project Phase information   
top
 

Project_Phase

part of: Project_Phase_Response_Data
Element containing all project phase information requested
 
Parameter name Type/Value Cardinality Description Validations
Project_Phase_Reference  Project_PhaseObject  [0..1]  Project Phase Reference   
Project_Phase_Data  Project_Phase_Data  [0..*]  Element Containing Project Plan Phase Data.   
top
 

Project_Phase_Data

part of: Project_Phase
Element Containing Project Plan Phase Data.
 
Parameter name Type/Value Cardinality Description Validations
Phase_ID  string  [0..1]  Phase ID. This is the phase unique identifier.   
Phase_Name  string  [1..1]  Contains Project Phase Name   
Description  string  [0..1]  Contains Project Phase Description   
top
 

Project_PhaseReferenceEnumeration

part of: Project_PhaseObjectID
Base Type
string
top