Service Directory > v31.2 > Resource_Management > Get_Project_Task_Resources
 

Operation: Get_Project_Task_Resources

The service operations would get all Project Task Resources for a Project reference or specified Project Task Resource Reference. Project Task Resource Data contains Project Task Resource ID,Project Plan Task Reference,Project Resource Plan Detail Reference,Worker Reference,Resource Start Date,Resource End Date,% Allocation,Estimated Hours


@ - 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_Task_Resources_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 [Choice]   Project_Task_Resources_Request_References  [0..1]  The Element contains Project Reference and Project Task Resource Reference for which Project Task Resources should be retrieved   
Request_Criteria [Choice]   Project_Task_Resources_Request_Criteria  [0..1]   
Response_Filter  Response_Filter  [0..1] 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Project_Task_Resources_Response_Group  [0..1]  This element contains data for Project Task Resource Get Request   
top
 

Response Element: Get_Project_Task_Resources_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_Task_Resources_Request_References  [0..1]  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.   
Request_Criteria  Project_Task_Resources_Request_Criteria  [0..1]   
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_Task_Resources_Response_Group  [0..1]   
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_Task_Resources_Response_Data  [0..1]   
top
 

Project_Task_Resources_Request_References

part of: Get_Project_Task_Resources_Request, Get_Project_Task_Resources_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  [0..*]   
top
 

ProjectObject

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

Project_Task_Resources_Request_Criteria

part of: Get_Project_Task_Resources_Request, Get_Project_Task_Resources_Response
.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Project_Task_Resources_Request, Get_Project_Task_Resources_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_Task_Resources_Response_Group

part of: Get_Project_Task_Resources_Request, Get_Project_Task_Resources_Response
.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Documentation Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.   
top
 

Response_Results

part of: Get_Project_Task_Resources_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_Task_Resources_Response_Data

part of: Get_Project_Task_Resources_Response
.
 
Parameter name Type/Value Cardinality Description Validations
Project_Task_Resources  Project_Task_Resources  [0..*]   
top
 

Project_Task_Resources

part of: Project_Task_Resources_Response_Data
.
 
Parameter name Type/Value Cardinality Description Validations
Project_Reference  ProjectObject  [0..1]   
Project_Task_Resources_Data  Project_Task_Resources_Data  [0..1] 
Validation Description
Project Task Resource Reference cannot be reassigned to a new Project   
The Web Service is set to Add Only; documents cannot be resubmitted.   
 
top
 

Project_Task_Resources_Data

part of: Project_Task_Resources
Wrapper Element for Project Task Resource Line Data Element
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  This flag controls whether or not to replace existing Project Task Resources for the Project. When true, existing Project Task Resources are removed before the data in this web service request is processed.   
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Project_ID  string  [0..1]  Project ID Reference 
Validation Description
Please enter either Project Reference or Project ID   
 
Project_Task_Resource_Line_Data  Project_Task_Resource_Line_Data  [0..*]  Element containing Project Task Resources related data to be processed by the wws 
Validation Description
Resource End Date cannot be before the Resource Start Date.  Resource End Date cannot be before the Resource Start Date. 
 
Validation Description
Project Task Resource Reference cannot be reassigned to a new Project   
The Web Service is set to Add Only; documents cannot be resubmitted.   
top
 

Project_Task_Resource_Line_Data

part of: Project_Task_Resources_Data
Element containing Project Task Resources related data to be processed by the wws
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  This flag controls whether specified Project Task Resource should be deleted (When Replace All Flag is true,then value of delete flag is ignored) 
Validation Description
Delete Flag cannot be True if no Project Task Resource Reference is specified or provided Project Task Resource Reference doesn't exist(Project Task Resource:[tr id])   
Project Task Resource cannot be deleted as its tied to Project(Project Task Resource:[tr],Project;[project])   
 
Project_Task_Resource_ID  string  [0..1]  Project Task Resource Reference ID 
Validation Description
Project Task Resource MLV Webservice Criticals   
 
Project_Plan_Task_Reference  Project_Plan_TaskObject  [1..1]  Project Plan Task Reference 
Validation Description
The Project Plan Task must be part of the selected Project (Project Plan Task: [task reference], Project: [project reference]).   
 
Project_Resource_Plan_Detail_Reference  Project_Resource_Plan_DetailObject  [1..1]  Project Resource Plan Detail Reference 
Validation Description
The Resource Plan Detail must be part of the selected Project (Resource Plan Detail: [rpd reference], Project: [project reference]).   
 
Project_Resource_Reference  Project_ResourceObject  [0..*]  Worker and Unnamed Resource reference for the Project Task Resource 
Validation Description
The Worker must be part of the selected Resource Plan Line (Worker: [worker reference], Resource Plan Line [rpd reference])   
 
Resource_Start_Date  date  [0..1]  Resource Start Date for the Project Task Resource   
Resource_End_Date  date  [0..1]  Resource End Date for the Project Task Resource   
Percent_Allocation  decimal (7, 4) >0   [0..1]  % Allocation for the Project Task Resource 
Validation Description
Task Percentage allocation cannot be entered if work relationship type is association for a Resource Plan detail (Resource Plan Detail: [rpd reference])   
 
Estimated_Hours  decimal (14, 2) >0   [0..1]  Estimated Hours for the Project Task Resource   
Memo  string  [0..1]  Memo for the Project Task Resource   
Validation Description
Resource End Date cannot be before the Resource Start Date.  Resource End Date cannot be before the Resource Start Date. 
top
 

Project_Plan_TaskObject

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

Project_Plan_TaskObjectID

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

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

Project_Resource_Plan_DetailObjectID

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

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

Project_ResourceObjectID

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

ProjectReferenceEnumeration

part of: ProjectObjectID
Base Type
string
top
 

Project_Plan_TaskReferenceEnumeration

part of: Project_Plan_TaskObjectID
Base Type
string
top
 

Project_Resource_Plan_DetailReferenceEnumeration

part of: Project_Resource_Plan_DetailObjectID
Base Type
string
top
 

Project_ResourceReferenceEnumeration

part of: Project_ResourceObjectID
Base Type
string
top