Service Directory > v32.1 > Resource_Management > Get_Project_Plans
 

Operation: Get_Project_Plans

This is the GET Project Plan web service.


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

Root element for the Request on the Get operation. Contains references, criteria, filter and response group for specifying which instances to return in the Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Plan_Request_References  [0..1]  Project references in GET request   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Project_Plans_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_Plan_Request_References  [0..1]  A list of references to retrieve using the get   
Response_Filter  Response_Filter  [0..1]  Element Content containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Project_Plan_Response_Data  [0..1]  Element containing Project Plan GET response data.   
top
 

Project_Plan_Request_References

part of: Get_Project_Plans_Request, Get_Project_Plans_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_Reference  ProjectObject  [1..*]  Project Reference   
top
 

ProjectObject

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

Response_Filter

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

Response_Results

part of: Get_Project_Plans_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_Plan_Response_Data

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

Project_Plan

part of: Project_Plan_Response_Data
Element containing all project plan information requested.
 
Parameter name Type/Value Cardinality Description Validations
Project_Reference  ProjectObject  [0..1]  Project Reference   
Project_Plan_Data  Project_Plan_Data  [0..1]  This element contains project plan data 
Validation Description
You cannot delete a project plan task associated with a timesheet entry, used as a contract milestone, included in the resource forecast, or used on a Project-Based service line: [tasks]   
You cannot delete a project plan phase with a task associated with a timesheet entry, used as a contract milestone, included in the resource forecast, or used on a Project-Based service line:[phases]   
Project Plan Template cannot be submitted when current phases/tasks are present   
 
top
 

Project_Plan_Data

part of: Project_Plan
Wrapper element for Project plan 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.   
Project_ID  string  [0..1]  Project ID. This is unique identifier.   
Project_Plan_Template_Reference  Project_Plan_TemplateObject  [0..1]  Project Plan Template   
Project_Plan_Phase_Data  Project_Plan_Phase_WWS_Data  [0..*]  Element Containing Project Plan Phase Data. 
Validation Description
The Phase ID: [id] is already in use by a different Project: [project].   
Project Phase Reference is required when creating a new Project Plan Phase for Project.   
 
Validation Description
You cannot delete a project plan task associated with a timesheet entry, used as a contract milestone, included in the resource forecast, or used on a Project-Based service line: [tasks]   
You cannot delete a project plan phase with a task associated with a timesheet entry, used as a contract milestone, included in the resource forecast, or used on a Project-Based service line:[phases]   
Project Plan Template cannot be submitted when current phases/tasks are present   
top
 

Project_Plan_TemplateObject

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

Project_Plan_TemplateObjectID

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

part of: Project_Plan_Data
Contains project plan data. Project plan consists of phases and tasks. If a phase name is not provided, all tasks identified will still be grouped under a phase. If the element is not included, removal of the phase is assumed and the phase and all tasks will be removed from the project, where valid to do so.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted.   
Project_Plan_Phase_ID  string  [0..1]  Phase ID. This is the phase unique identifier.   
Order  string  [0..1]  Specifies the display order of the phase in the project plan.   
Phase_Reference  Project_PhaseObject  [0..1]  Project Phase Reference 
Validation Description
Project Plan Phase MLV Webservice Criticals   
 
Project_Plan_Task_Data  Project_Plan_Task_WWS_Data  [0..*]  Contains task data that are grouped under a phase. 
Validation Description
Milestone Flag must be on when the Task is currently in use as a Milestone.   
Task End Date cannot be before the Task Start Date.   
Project Task cannot be changed if the Project Plan Task is referenced as a Worktag.   
Task Name can't be changed if the Project Plan Task has time entered.   
End Date is required for contract milestones tasks marked complete. See task [task].   
The Project Plan Task ID: [id] is already in use by a different Project Plan Phase: [phase].   
The Task ID: [id] cannot be used more than once.   
Project Task Reference is required when creating a new Project Plan Task.   
Non-Billable Flag cannot be updated on a Non-Billable Project.   
 
Validation Description
The Phase ID: [id] is already in use by a different Project: [project].   
Project Phase Reference is required when creating a new Project Plan Phase for Project.   
top
 

Project_PhaseObject

part of: Project_Plan_Phase_WWS_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_Plan_Task_WWS_Data

part of: Project_Plan_Phase_WWS_Data
This element contains the Project Plan Task Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted.   
Project_Plan_Task_ID  string  [0..1]  Task ID. This is the task unique identifier within a phase.   
Order  string  [0..1]  Specifies the display order of the task within the phase of a project plan.   
Task_Reference  Project_TaskObject  [0..1]  Project Task Reference 
Validation Description
Project Plan Task MLV Webservice Criticals   
 
Custom_Task_Name  string  [0..1]  Custom Task Name   
Start_Date  date  [0..1]  Task Start Date cannot be after Project End Date.   
End_Date  date  [0..1]  Task End Date cannot be after the Project End Date. 
Validation Description
Task End Date cannot be before the Task Start Date.   
This milestone task is associated to a contract. Confirm that end date should be greater than today's date.   
 
Percent_Complete  decimal (7, 4) >0   [0..1]  Percent in decimal format, ex: enter 1 for 100%, .5 for 50%, etc 
Validation Description
This contract milestone task was marked complete. Please confirm the end date is correct.   
Verify that the End Date is correct for this completed contract milestone task.   
 
Non-Billable  boolean  [0..1]  Non-Billable   
Milestone  boolean  [0..1]  Indicates if the task is a project milestone.   
Closed  boolean  [0..1]  Checking the task Closed will prevent any additional time to be reported for the specified task.   
Utilization  boolean  [0..1]  For informational purposes only to indicate that this project plan task qualifies for utilization calculations.   
Memo  string  [0..1]  Free form text capturing comments about the task.   
Task_Attachment_Data  Financials_Attachment_Data  [0..*]  Attachment File 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
Milestone Flag must be on when the Task is currently in use as a Milestone.   
Task End Date cannot be before the Task Start Date.   
Project Task cannot be changed if the Project Plan Task is referenced as a Worktag.   
Task Name can't be changed if the Project Plan Task has time entered.   
End Date is required for contract milestones tasks marked complete. See task [task].   
The Project Plan Task ID: [id] is already in use by a different Project Plan Phase: [phase].   
The Task ID: [id] cannot be used more than once.   
Project Task Reference is required when creating a new Project Plan Task.   
Non-Billable Flag cannot be updated on a Non-Billable Project.   
top
 

Project_TaskObject

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

Financials_Attachment_Data

part of: Project_Plan_Task_WWS_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

ProjectReferenceEnumeration

part of: ProjectObjectID
Base Type
string
top
 

Project_Plan_TemplateReferenceEnumeration

part of: Project_Plan_TemplateObjectID
Base Type
string
top
 

Project_PhaseReferenceEnumeration

part of: Project_PhaseObjectID
Base Type
string
top
 

Project_TaskReferenceEnumeration

part of: Project_TaskObjectID
Base Type
string
top