Creates a Resource Plan Line Edit event and initiates the Project Resource Plan Line business process.

Workday Resource Information

Special Processing

If Resource Type is changed from Association to Assignment
-Any Worker Group on the Resource Plan Line will be removed
-Any Excluded Workers on the Resource Plan Line will be removed

If Resource Type is changed from Assignment to Association
-Any Workers on the Resource Plan Line will be removed
-Any Unnamed Resources on the Resource Plan Line will be removed
-The “To be hired" flag will be set to false
-The % Allocation field will be set to 100%
-The Estimated Hours field will be set to zero

If To be hired is changed from True to False
-Any Job Requisition on the Resource Plan Line will be removed

If To be hired is changed from False to True
-Any Workers on the Resource Plan Line will be removed
-Any Unnamed Resources on the Resource Plan Line will be removed.


To determine if business process validation errors occurred, inspect the businessEventValidation array in the response.

Secured by: Patch Project Resource Plan (REST Service)

Scope: Project Tracking

Aggregate Fields

The server represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

BusinessEventRecords_Aggregate

[{
  awaitingPersons: [{
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }]
  businessEventValidation: [{
      conditionRule: Text /* The condition rule as a text expression. */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }]
  businessProcessStep: { /* Retired. We retire this report field because it doesn't return all the steps on the business process definition that are associated with the business process event step. A business process event step can be associated with multiple steps from the business process definition if those steps were automatically skipped. Example: Entry conditions to those steps aren't met. We recommend that you use the Steps report field instead. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  comments: [{
      comment: Text /* Comment */
      conmentDate: Date /* Gives the moment at which the instance was originally created. */
      person: { /* Comment made by Person */
         -descriptor: Text /* A description of the instance */
         -href: Text /* A link to the instance */
         *id: Text /* wid / id / reference id */
      }
  }]
  completedByPerson: { /* The person that completed the step as Assignee */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  completedOn: Date /* The date when this step was completed */
  creationDate: Date /* The date when the event record was created. */
  delayedDate: Date /* The date the delayed step will trigger. */
  descriptor: Text /* A preview of the instance */
  due: Date /* Returns the due date for this step. */
  event: { /* The business process associated with the project you're editing. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  id: Text /* Id of the instance */
  status: { /* The status of this business process step. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

ExcludedWorkers_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

PendingWorkers_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

ProjectResources_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Requirements_Aggregate

[{
  category: { /* The requirement category for the \~project role\~. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
  optional: Boolean /* The optional status of a requirement. */
  values: [{
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }]
}]

UnnamedResourceWorkerSwap_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
  unnamedResource: { /* Unnamed Resource */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  worker: { /* Worker */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Input

Name	Type	Description
ResourcePlanLines_Id	String	Unique identifier for the resource plan line.
BookingStatus_Id	String	Unique identifier for the booking status of the resource.
BusinessEventRecords_Aggregate	String	List of business events related to project resource planning.
CostRateCurrencyOverride_Id	String	Unique identifier for the currency override applied to cost rate.
CostRateOverride_Currency	String	Currency used for overriding the cost rate.
CostRateOverride_Value	Decimal	The value of the cost rate override.
Descriptor	String	A brief preview or summary of the resource plan line.
EndDate	Datetime	The planned end date for the resource plan line.
EstimatedHours	Decimal	Total estimated hours required for this role in the project.
ExcludedWorkers_Aggregate	String	List of workers excluded from assignment to the resource plan line.
Id	String	Unique identifier for the specific instance of the resource plan line.
JobRequisition_Id	String	Unique identifier for the job requisition linked to the resource plan.
Memo	String	Additional notes or comments related to the resource plan line.
PercentAllocation	Decimal	Percentage of a worker’s time allocated to the project for the resource plan line.
ProjectResources_Aggregate	String	The workers and unnamed resources assigned to the resource plan line.
Requirements_Aggregate	String	Contains the specific requirements by category for the project role.
ResourceType_Id	String	Unique identifier for the type of resource associated with the role.
RoleCategory_Id	String	Unique identifier for the category of role in the project.
Role_Id	String	Unique identifier for the specific role within the project.
StartDate	Datetime	The planned start date for the resource plan line.
ToBeHired	Bool	Indicates whether a new worker is still required for the resource plan line.
UnnamedResourceWorkerSwap_Aggregate	String	Details about unnamed resource worker swaps within the project.
UnnamedResources	Decimal	Placeholder for unnamed resources assigned to the resource plan.
WorkerGroup_Id	String	Unique identifier for the worker group associated with the plan.

Result Set Columns

Name	Type	Description
BookingStatus_Descriptor	String	Description of the booking status for the resource.
BookingStatus_Href	String	URL link to the booking status instance.
BookingStatus_Id	String	Unique identifier for the booking status of the resource.
BusinessEventRecords_Aggregate	String	List of business events related to project resource planning.
CostRateCurrencyOverride_Descriptor	String	Description of the cost rate currency override.
CostRateCurrencyOverride_Href	String	URL link to the cost rate currency override.
CostRateCurrencyOverride_Id	String	Unique identifier for the currency override applied to cost rate.
CostRateOverride_Currency	String	Currency used for overriding the cost rate.
CostRateOverride_Value	Decimal	The value of the cost rate override.
Descriptor	String	A brief preview or summary of the resource plan line.
EndDate	Datetime	The planned end date for the resource plan line.
EstimatedHours	Decimal	Total estimated hours required for this role in the project.
ExcludedWorkers_Aggregate	String	List of workers excluded from assignment to the resource plan line.
Id	String	Unique identifier for the specific instance of the resource plan line.
JobRequisition_Descriptor	String	Description of the job requisition associated with the resource plan.
JobRequisition_Href	String	URL link to the job requisition instance.
JobRequisition_Id	String	Unique identifier for the job requisition linked to the resource plan.
Memo	String	Additional notes or comments related to the resource plan line.
PendingWorkers_Aggregate	String	List of workers pending approval to be added to the resource plan line.
PercentAllocation	Decimal	Percentage of a worker’s time allocated to the project for the resource plan line.
ProjectResources_Aggregate	String	The workers and unnamed resources assigned to the resource plan line.
Requirements_Aggregate	String	Contains the specific requirements by category for the project role.
ResourceType_Descriptor	String	Description of the type of resource assigned to the project.
ResourceType_Href	String	URL link to the resource type instance.
ResourceType_Id	String	Unique identifier for the type of resource associated with the role.
RoleCategory_Descriptor	String	Description of the role category in the project.
RoleCategory_Href	String	URL link to the role category instance.
RoleCategory_Id	String	Unique identifier for the category of role in the project.
Role_Descriptor	String	Description of the role within the project.
Role_Href	String	URL link to the role instance.
Role_Id	String	Unique identifier for the specific role within the project.
StartDate	Datetime	The planned start date for the resource plan line.
ToBeHired	Bool	Indicates whether a new worker is still required for the resource plan line.
UnnamedResourceWorkerSwap_Aggregate	String	Details about unnamed resource worker swaps within the project.
UnnamedResources	Decimal	Placeholder for unnamed resources assigned to the resource plan.
WorkerGroup_Descriptor	String	Description of the worker group associated with the resource plan.
WorkerGroup_Href	String	URL link to the worker group instance.
WorkerGroup_Id	String	Unique identifier for the worker group associated with the plan.