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 cmdlet 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	The ID of the resource to execute this process on.
BookingStatus_Id	String	wid / id / reference id
BusinessEventRecords_Aggregate	String	A JSON aggregate. project resource plan business event for rest api
CostRateCurrencyOverride_Id	String	wid / id / reference id
CostRateOverride_Currency	String	Cost Rate Override (Currency name)
CostRateOverride_Value	Decimal	Cost Rate Override (Value)
Descriptor	String	A preview of the instance
EndDate	Datetime	The date the resource plan line ends.
EstimatedHours	Decimal	The total number of work hours estimated for the role on project resource plan line.
ExcludedWorkers_Aggregate	String	A JSON aggregate. The workers in the selected worker group who are excluded from assignment to the resource plan line.
Id	String	Id of the instance
JobRequisition_Id	String	wid / id / reference id
Memo	String	memo
PercentAllocation	Decimal	The percent allocation of the worker's time on the project in their assigned role for the resource plan line.
ProjectResources_Aggregate	String	A JSON aggregate. The workers and unnamed resources assigned to the resource plan line.
Requirements_Aggregate	String	A JSON aggregate. Contains the specific requirements by category for the project role.
ResourceType_Id	String	wid / id / reference id
RoleCategory_Id	String	wid / id / reference id
Role_Id	String	wid / id / reference id
StartDate	Datetime	The date the resource plan line starts.
ToBeHired	Bool	Returns true if the resource plan line requires a worker a resource still needs to be hired.
UnnamedResourceWorkerSwap_Aggregate	String	A JSON aggregate. Unnamed Resource Worker Swap
UnnamedResources	Decimal	The unnamed resource assigned as a placeholder on the resource plan.
WorkerGroup_Id	String	wid / id / reference id

Result Set Columns

Name	Type	Description
BookingStatus_Descriptor	String	A description of the instance
BookingStatus_Href	String	A link to the instance
BookingStatus_Id	String	wid / id / reference id
BusinessEventRecords_Aggregate	String	A JSON aggregate. project resource plan business event for rest api
CostRateCurrencyOverride_Descriptor	String	A description of the instance
CostRateCurrencyOverride_Href	String	A link to the instance
CostRateCurrencyOverride_Id	String	wid / id / reference id
CostRateOverride_Currency	String	Cost Rate Override (Currency name)
CostRateOverride_Value	Decimal	Cost Rate Override (Value)
Descriptor	String	A preview of the instance
EndDate	Datetime	The date the resource plan line ends.
EstimatedHours	Decimal	The total number of work hours estimated for the role on project resource plan line.
ExcludedWorkers_Aggregate	String	A JSON aggregate. The workers in the selected worker group who are excluded from assignment to the resource plan line.
Id	String	Id of the instance
JobRequisition_Descriptor	String	A description of the instance
JobRequisition_Href	String	A link to the instance
JobRequisition_Id	String	wid / id / reference id
Memo	String	memo
PendingWorkers_Aggregate	String	A JSON aggregate. Contains the workers event pending approval to be added to the resource plan line.
PercentAllocation	Decimal	The percent allocation of the worker's time on the project in their assigned role for the resource plan line.
ProjectResources_Aggregate	String	A JSON aggregate. The workers and unnamed resources assigned to the resource plan line.
Requirements_Aggregate	String	A JSON aggregate. Contains the specific requirements by category for the project role.
ResourceType_Descriptor	String	A description of the instance
ResourceType_Href	String	A link to the instance
ResourceType_Id	String	wid / id / reference id
RoleCategory_Descriptor	String	A description of the instance
RoleCategory_Href	String	A link to the instance
RoleCategory_Id	String	wid / id / reference id
Role_Descriptor	String	A description of the instance
Role_Href	String	A link to the instance
Role_Id	String	wid / id / reference id
StartDate	Datetime	The date the resource plan line starts.
ToBeHired	Bool	Returns true if the resource plan line requires a worker a resource still needs to be hired.
UnnamedResourceWorkerSwap_Aggregate	String	A JSON aggregate. Unnamed Resource Worker Swap
UnnamedResources	Decimal	The unnamed resource assigned as a placeholder on the resource plan.
WorkerGroup_Descriptor	String	A description of the instance
WorkerGroup_Href	String	A link to the instance
WorkerGroup_Id	String	wid / id / reference id