Service Directory > v25.1 > Resource_Management > Put_Project_Resource_Plan
 

Operation: Put_Project_Resource_Plan DEPRECATED

DEPRECATED: Please use Submit Resource Plan operation instead. This service operation will add or update Project Resource Plan. A project resource plan can be directly assigned to a project or shared via a project hierarchy. Project resource plan data includes the Plan name and the Project or Project Hierarchy to which the plan may be associated. Detail data includes Project Profile, Start Date, End Date, Restricted to Worker, Percent Allocation, Contract Billing Rate and Currency, Override Hourly Internal Rate and Currency.


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

Element containing Project Resource Plan reference for update and all Project Resource Plan Detail data
 
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_Resource_Plan_Reference  Project_Resource_PlanObject  [0..1]  Reference to an existing Project Resource Plan for update only purpose   
Project_Resource_Plan_Data  Project_Resource_Plan_Data  [1..1]  Contains data for a Project Resource Plan 
Validation Description
Please provide either a Project or Project Hierarchy for the Project Resource Plan   
The Project Hierarchy or Project associated with a Project Resource Plan cannot be changed when it is already in use by a Project.   
The specified Project has Project Member Resources that are not defined in the Details for the current Resource Plan.   
The selected Project Hierarchy has Project Member Resources for Projects sharing its Resource Plan that are not defined in the Details for the current Resource Plan.   
Start Date and End Date may not be specified if the Project Resource Plan is for a Project Hierarchy   
The selected Project Hierarchy has Workers for Projects sharing its Resource Plan that are not valid for the Details of the current Resource Plan.   
The project hierarchy provided must be approved.   
Project reference is for a project that can be used as a basic worktag only.   
Resource Plan cannot be submitted for an inactive Project Hierarchy.   
Resource Plan cannot be submitted for an inactive Project.   
You are attempting to delete Project Resource Plan Details that contain Pending Restricted to Workers. Ensure that there are no remaining Pending Restricted to Workers to be able to delete the Project Resource Plan Details : [Plan]   
You are attempting to delete Project Resource Plan Details that is used by Project Plan Task   
 
Validation Description
Project Resource Plan ID already exists.   
This web service is no longer supported with Enhanced Resource Management enabled.   
top
 

Response Element: Project_Resource_Plan_Response

Element containing Project Resource Plan Response data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Project_Resource_Plan_Reference  Project_Resource_PlanObject  [0..1]  Project Resource Plan Reference   
top
 

Project_Resource_PlanObject

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

Project_Resource_PlanObjectID

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

part of: Put_Project_Resource_Plan_Request
Element containing all Project Resource Plan data. If this element is not included, removal of the plan is assumed and the plan and details will be removed from the project or project hierarchy, where valid to do so.
 
Parameter name Type/Value Cardinality Description Validations
Project_Resource_Plan_ID  string  [0..1]  Project Resource Plan ID. This is the Project Resource Plan unique identifier   
Name  string  [0..1]  Free form text field for a meaningful Project Resource Plan Name   
Project_Reference [Choice]   Project_AbstractObject  [0..1]  Project Reference   
Project_Hierarchy_Reference [Choice]   Project_HierarchyObject  [0..1]  Project Hierarchy reference. Any Project under the current Hierarchy will inherit the Resource Plan from the Project Hierarchy unless it is explicitly defined for a given Project or child Project Hierarchy.   
Detail_Replacement_Data  Project_Resource_Plan_Detail_Data  [0..*]  Element containing resource plan detail data. If this element is not included, removal of the plan detail is assumed and the plan detail will be removed from the project, where valid to do so. 
Validation Description
The Project Member Resource: [member resource] is referenced by a Project Plan Task and cannot be modified on the Detail with ID: [detail id].   
Resource End Date cannot be before the Resource Start Date.   
Resource End Date cannot be before the Project Start Date.   
Resource End Date cannot be after the Project End Date.   
Resource Start Date cannot be after Project End Date.   
Resource Start Date cannot be before Project Start Date.   
At least one of the tasks associated with the Project Member Resource: [member resource] has a date range outside that defined on the Resource Plan.   
At least one Task for the specified Project falls outside of the date range specified for the Resource Plan candidates using the Project Member Resource: [member resource]   
There are workers assigned to project tasks that are not on the Project Resource Plan for the associated Project Member Resource. Review the workers' assignment on the project plan and add them to the resource plan.   
Project Worker Role cannot have Workers excluded.   
One or more workers directly assigned to project tasks are excluded from the resource plan detail. Remove the workers directly assigned to the tasks before excluding them from the resource plan. Reference: - Plan Detail: [detail], - Workers: [workers], - Tasks: [tasks]   
You cannot add a Restricted to Worker who is currently a Pending Restricted to Worker.   
You cannot assign workers directly to a project task when the associated resource plan detail contains pending restricted to workers but no restricted to workers. Remove the workers directly assigned to the tasks until they are approved as restricted to workers on the resource plan. Reference: Plan Detail: [detail]   
Resource Plan Detail can either have Worker Restrictions (including Pending Worker Restrictions) or Worker Exclusions defined but not both. (Resource Plan Detail ID: [detail])   
Resource Plan Detail ID is already referenced on a another Resource Plan and cannot be added to this resource plan. (Resource Plan Detail ID: [detail])   
 
Validation Description
Please provide either a Project or Project Hierarchy for the Project Resource Plan   
The Project Hierarchy or Project associated with a Project Resource Plan cannot be changed when it is already in use by a Project.   
The specified Project has Project Member Resources that are not defined in the Details for the current Resource Plan.   
The selected Project Hierarchy has Project Member Resources for Projects sharing its Resource Plan that are not defined in the Details for the current Resource Plan.   
Start Date and End Date may not be specified if the Project Resource Plan is for a Project Hierarchy   
The selected Project Hierarchy has Workers for Projects sharing its Resource Plan that are not valid for the Details of the current Resource Plan.   
The project hierarchy provided must be approved.   
Project reference is for a project that can be used as a basic worktag only.   
Resource Plan cannot be submitted for an inactive Project Hierarchy.   
Resource Plan cannot be submitted for an inactive Project.   
You are attempting to delete Project Resource Plan Details that contain Pending Restricted to Workers. Ensure that there are no remaining Pending Restricted to Workers to be able to delete the Project Resource Plan Details : [Plan]   
You are attempting to delete Project Resource Plan Details that is used by Project Plan Task   
top
 

Project_AbstractObject

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

Project_AbstractObjectID

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

part of: Project_Resource_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_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
 

Project_Resource_Plan_Detail_Data

part of: Project_Resource_Plan_Data
Element containing resource plan detail data. If this element is not included, removal of the plan detail is assumed and the plan detail will be removed from the project, where valid to do so.
 
Parameter name Type/Value Cardinality Description Validations
Detail_ID  string  [0..1]  Detail ID. This is the project resource plan detail unique identifier.   
Member_Resource_Reference  Project_Member_ResourceObject  [1..1]  Project Member Resource Reference. Member Resource can be a Job Profile, Project Worker Role, Cost Center, or Talent Pool.   
Start_Date  date  [0..1]  Start Date   
End_Date  date  [0..1]  End Date   
Worker_Reference  WorkerObject  [0..*]  A subset of the possible workers from the member resource considered to be members of the resource plan detail. This may be a subset of workers for the respective member resource. If no workers are defined in the Worker Reference, all workers who are members of the member resource are available for task assignment unless excluded in the Excluded Worker Reference. 
Validation Description
Restricted Workers are not valid for Project Member Resource: [Project Member Resource]   
 
Excluded_Workers_Reference  WorkerObject  [0..*]  List of workers excluded from the Member Resource reference for the resource plan detail. Workers listed here are not available for task assignment. Does not apply Member Resource type of Project Worker Role. 
Validation Description
Excluded Workers are not valid for Project Member Resource: [Project Member Resource]   
 
Percent_Allocation  decimal (5, 2) >0   [0..1]  Percent in decimal format, ex: enter 1 for 100%, .5 for 50%, etc   
Internal_Rate_Data  Internal_Rate_Override_Data  [0..1]  Element containing the Override Internal Rate and Override Internal Currency. 
Validation Description
Override Internal Currency Reference is required if Override Internal Rate is specified.   
 
Billing_Rate_Data  Billing_Rate_Override_Data  [0..1]  Element containing the Contracted Billing Rate and Contracted Billing Rate Currency. 
Validation Description
Contracted Billing Currency Reference is required if Contracted Billing Rate is specified.   
 
Validation Description
The Project Member Resource: [member resource] is referenced by a Project Plan Task and cannot be modified on the Detail with ID: [detail id].   
Resource End Date cannot be before the Resource Start Date.   
Resource End Date cannot be before the Project Start Date.   
Resource End Date cannot be after the Project End Date.   
Resource Start Date cannot be after Project End Date.   
Resource Start Date cannot be before Project Start Date.   
At least one of the tasks associated with the Project Member Resource: [member resource] has a date range outside that defined on the Resource Plan.   
At least one Task for the specified Project falls outside of the date range specified for the Resource Plan candidates using the Project Member Resource: [member resource]   
There are workers assigned to project tasks that are not on the Project Resource Plan for the associated Project Member Resource. Review the workers' assignment on the project plan and add them to the resource plan.   
Project Worker Role cannot have Workers excluded.   
One or more workers directly assigned to project tasks are excluded from the resource plan detail. Remove the workers directly assigned to the tasks before excluding them from the resource plan. Reference: - Plan Detail: [detail], - Workers: [workers], - Tasks: [tasks]   
You cannot add a Restricted to Worker who is currently a Pending Restricted to Worker.   
You cannot assign workers directly to a project task when the associated resource plan detail contains pending restricted to workers but no restricted to workers. Remove the workers directly assigned to the tasks until they are approved as restricted to workers on the resource plan. Reference: Plan Detail: [detail]   
Resource Plan Detail can either have Worker Restrictions (including Pending Worker Restrictions) or Worker Exclusions defined but not both. (Resource Plan Detail ID: [detail])   
Resource Plan Detail ID is already referenced on a another Resource Plan and cannot be added to this resource plan. (Resource Plan Detail ID: [detail])   
top
 

Project_Member_ResourceObject

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

Project_Member_ResourceObjectID

part of: Project_Member_ResourceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Cost_Center_Reference_ID, Job_Profile_ID, Organization_Reference_ID, Project_Dynamic_Resource_Pool_ID, Project_Worker_Role_ID, Talent_Pool_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
 

WorkerObject

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

WorkerObjectID

part of: WorkerObject
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  [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
 

Internal_Rate_Override_Data

part of: Project_Resource_Plan_Detail_Data
Element containing the Override Internal Rate and Override Internal Currency.
 
Parameter name Type/Value Cardinality Description Validations
Override_Internal_Rate  decimal (26, 6) >0   [0..1]  Hourly override internal rate. A non-zero value in this field will override the default rate from the internal rate sheet for all workers that match the Compensation Grade and/or Compensation Grade Profile if one is defined.   
Override_Internal_Currency_Reference  CurrencyObject  [0..1]  Currency Reference for the Internal Rate. This is defaulted from the Internal Rate Sheet if not defined.   
Validation Description
Override Internal Currency Reference is required if Override Internal Rate is specified.   
top
 

CurrencyObject

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

CurrencyObjectID

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

Billing_Rate_Override_Data

part of: Project_Resource_Plan_Detail_Data
Element containing the Contracted Billing Rate and Contracted Billing Rate Currency.
 
Parameter name Type/Value Cardinality Description Validations
Contracted_Billing_Rate  decimal (21, 6) >0   [0..1]  Hourly contracted billing rate. A non-zero value in this field will override the default rates on the billing rate sheet for Job Profile or Project Worker Role if one is defined.   
Contracted_Billing_Currency_Reference  CurrencyObject  [0..1]  Currency Reference for the Contracted Billing Rate. This field is required only if the Contracted Billing Rate is specified.   
Validation Description
Contracted Billing Currency Reference is required if Contracted Billing Rate is specified.   
top
 

Project_Resource_PlanReferenceEnumeration

part of: Project_Resource_PlanObjectID
Base Type
string
top
 

Project_AbstractReferenceEnumeration

part of: Project_AbstractObjectID
Base Type
string
top
 

Project_HierarchyReferenceEnumeration

part of: Project_HierarchyObjectID
Base Type
string
top
 

Project_Member_ResourceReferenceEnumeration

part of: Project_Member_ResourceObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top