Cmdlets for Workday

Build 25.0.9434

ResourcePlanLines

Stores individual resource planning line items, detailing resource allocation.

Workday Resource Information

Retrieve Resource Plan Line as specified by ID.

Secured by: Manage: Project, Manage: Project Details, Self-Service: Project, View: Project

Scope: Project Tracking, Projects

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 */
}]

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 */
  }]
}]

Workers_Aggregate


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

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique Workday ID for this instance.

BookingStatus_Descriptor String False

A description of the booking status for the resource plan line.

BookingStatus_Href String False

A link to the instance representing the booking status.

BookingStatus_Id String False

The Workday ID for the booking status.

BusinessEventRecords_Aggregate String False

Contains the Project Resource Plan Line Event business process records triggered when a resource plan line is created or modified.

CostRateCurrencyOverride_Descriptor String False

A description of the currency override for cost rate.

CostRateCurrencyOverride_Href String False

A link to the instance representing the currency override for cost rate.

CostRateCurrencyOverride_Id String False

The Workday ID for the cost rate currency override.

CostRateOverride_Currency String False

The currency associated with the cost rate override.

CostRateOverride_Value Decimal False

The hourly cost rate assigned to a worker for project time costing.

Descriptor String False

A general preview or description of the resource plan line instance.

EndDate Datetime False

The planned end date for the resource plan line.

EstimatedHours Decimal False

The total estimated work hours allocated for the project role in this resource plan line.

ExcludedWorkers_Aggregate String False

Lists workers from the selected worker group who are excluded from assignment to this resource plan line.

JobRequisition_Descriptor String False

A description of the job requisition associated with this resource plan.

JobRequisition_Href String False

A link to the job requisition instance.

JobRequisition_Id String False

The Workday ID for the job requisition.

Memo String False

Additional comments or details related to this resource plan line.

PercentAllocation Decimal False

The percentage of the worker's time allocated to this project role.

Project_Id String False

The Workday ID for the project associated with this resource plan line.

Requirements_Aggregate String False

Lists the specific role requirements categorized for this project.

ResourceType_Descriptor String False

A description of the type of resource being assigned.

ResourceType_Href String False

A link to the instance representing the resource type.

ResourceType_Id String False

The Workday ID for the resource type.

RoleCategory_Descriptor String False

A description of the category of the assigned role.

RoleCategory_Href String False

A link to the role category instance.

RoleCategory_Id String False

The Workday ID for the role category.

Role_Descriptor String False

A description of the role being assigned in the resource plan.

Role_Href String False

A link to the instance representing the role.

Role_Id String False

The Workday ID for the assigned role.

StartDate Datetime False

The planned start date for the resource plan line.

ToBeHired Bool False

Indicates if a worker is yet to be hired for this resource plan line (true/false).

UnnamedResources Decimal False

The number of unnamed resources (placeholders) allocated in the plan.

WorkerGroup_Descriptor String False

A description of the worker group associated with this plan.

WorkerGroup_Href String False

A link to the instance representing the worker group.

WorkerGroup_Id String False

The Workday ID for the worker group.

Workers_Aggregate String False

A list of assigned workers in this resource plan line.

ProjectResourcePlan_Prompt String False

Reference input for retrieving the relevant project resource plan.

Project_Prompt String False

Reference input for retrieving the relevant project.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434