Cmdlets for Workday

Build 24.0.9060

ResourcePlanLines

Retrieves a single resource plan line instance.

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.

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. */
     *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 */
         *id: Text /* wid / id / reference id */
      }
  }]
  completedByPerson: { /* The person that completed the step as Assignee */
     *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: { /* Identifies the business process and allows you to drill into the details and access related actions. */
     *id: Text /* wid / id / reference id */
  }
  id: Text /* Id of the instance */
  status: { /* The status of this business process step. */
     *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\~. */
     *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

Id of the instance

BookingStatus_Descriptor String False

Supported for: SELECT. A description of the instance

BookingStatus_Href String False

Supported for: SELECT. A link to the instance

BookingStatus_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

BusinessEventRecords_Aggregate String False

Supported for: INSERT. A JSON aggregate. The Project Resource Plan Line Event business process record that's initiated when you create or change a resource plan line for a given resource plan.

CostRateCurrencyOverride_Descriptor String False

Supported for: SELECT. A description of the instance

CostRateCurrencyOverride_Href String False

Supported for: SELECT. A link to the instance

CostRateCurrencyOverride_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

CostRateOverride_Currency String False

Supported for: SELECT, INSERT. The amount per hour a worker will contribute to the time cost of a project. (Currency name)

CostRateOverride_Value Decimal False

Supported for: SELECT, INSERT. The amount per hour a worker will contribute to the time cost of a project. (Value)

Descriptor String False

Supported for: SELECT, INSERT. A preview of the instance

EndDate Datetime False

Supported for: SELECT, INSERT. The date the resource plan line ends.

EstimatedHours Decimal False

Supported for: SELECT, INSERT. The total number of work hours estimated for the role on project resource plan line.

ExcludedWorkers_Aggregate String False

Supported for: INSERT. A JSON aggregate. The workers in the selected worker group who are excluded from assignment to the resource plan line.

JobRequisition_Descriptor String False

Supported for: SELECT. A description of the instance

JobRequisition_Href String False

Supported for: SELECT. A link to the instance

JobRequisition_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

Memo String False

Supported for: SELECT, INSERT. Additional details for the resource plan line.

PercentAllocation Decimal False

Supported for: SELECT, INSERT. The percent allocation of the worker's time on the project in their assigned role for the resource plan line.

Project_Id String False

Supported for: INSERT. wid / id / reference id

Requirements_Aggregate String False

Supported for: INSERT. A JSON aggregate. Contains the specific requirements by category for the project role.

ResourceType_Descriptor String False

Supported for: SELECT. A description of the instance

ResourceType_Href String False

Supported for: SELECT. A link to the instance

ResourceType_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

RoleCategory_Descriptor String False

Supported for: SELECT. A description of the instance

RoleCategory_Href String False

Supported for: SELECT. A link to the instance

RoleCategory_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

Role_Descriptor String False

Supported for: SELECT. A description of the instance

Role_Href String False

Supported for: SELECT. A link to the instance

Role_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

StartDate Datetime False

Supported for: SELECT, INSERT. The date the resource plan line starts.

ToBeHired Bool False

Supported for: SELECT, INSERT. Returns true if the resource plan line requires a worker a resource still needs to be hired.

UnnamedResources Decimal False

Supported for: INSERT. The unnamed resource assigned as a placeholder on the resource plan.

WorkerGroup_Descriptor String False

Supported for: SELECT. A description of the instance

WorkerGroup_Href String False

Supported for: SELECT. A link to the instance

WorkerGroup_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

Workers_Aggregate String False

Supported for: INSERT. A JSON aggregate. The workers assigned to the resource plan line.

ProjectResourcePlan_Prompt String False

No description available.

Project_Prompt String False

No description available.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060