ProjectsEdit

Creates Project Edit Events and initiates the associated workflow to update the project.

Workday Resource Information

Creates a Project Edit Event business process and initiates the workflow to partially update the existing project with the specified data in the request body for the specified ID. In the request body, specify at least these required fields: ProjectHierarchy {id}, ProjectName, ProjectStartDate. Use the mm-dd-yyyy format. This endpoint is equivalent to the Create Project task in Workday.

Secured by: Patch Project (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 */
  }
}]

Groups_Aggregate

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

ProjectDependencies_Aggregate

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

Worktags_Aggregate

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

Input


Name	Type	Description
Projects_Id	String	The ID of the resource to execute this process on.
Billable	Bool	When True, the project becomes a billable project.
BusinessEventRecords_Aggregate	String	A JSON aggregate. All event records for the latest Edit Project event.
Capital	Bool	When true, the project is capital.
Company_Id	String	wid / id / reference id
Currency_Descriptor	String	A preview of the instance
Currency_Id	String	Id of the instance
Customer_Id	String	wid / id / reference id
Description	String	The description of the project.
EndDate	Datetime	The end date for the approved project .
EstimatedBudget_Currency	String	The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. (Currency name)
EstimatedBudget_Value	Decimal	The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. (Value)
EstimatedRevenueSavings_Currency	String	The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Currency name)
EstimatedRevenueSavings_Value	Decimal	The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Value)
ExternalLink	String	The link to an external site.
ExternalProjectReference	String	Returns the external project reference.
Groups_Aggregate	String	A JSON aggregate. Identifies the project groups of a project. Project groups are used to organize projects for worktag prompting.
Href	String	A link to the instance
Id	String	Id of the instance
ImportanceRating_Id	String	wid / id / reference id
InScope	String	A description of what is considered to be in scope for the project.
Inactive	Bool	When True, the current project or the associated project hierarchy becomes inactive.
IncludeProjectIDInName	Bool	When true, displays the ID in the Project name.
MeasuresOfSuccess	String	A description of what the project will be measured against to determine if it is successful.
Name	String	The approved project name.
Objective	String	A description of the desired outcome of the project.
OutOfScope	String	A description of what is considered to be out of scope for the project.
Overview	String	Project overview describing additional details about the project
Owner_Id	String	wid / id / reference id
PercentComplete	Decimal	The percent complete for the project.
Priority_Id	String	wid / id / reference id
ProbabilityOfSuccess	Decimal	Indicates the probability of the project's success.
ProblemStatement	String	A description of the problem to be resolved by the project.
ProjectDependencies_Aggregate	String	A JSON aggregate. Contains the list of projects defined as dependencies to the project.
RealizedRevenueSavings_Currency	String	The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Currency name)
RealizedRevenueSavings_Value	Decimal	The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Value)
RiskLevel_Id	String	wid / id / reference id
StartDate	Datetime	The start date of the approved project.
Status_Id	String	wid / id / reference id
SuccessRating_Id	String	wid / id / reference id
Worktags_Aggregate	String	A JSON aggregate. Key words for projects to categorize transactions, such as Cost, Organization, etc.

Result Set Columns


Name	Type	Description
Billable	Bool	When True, the project becomes a billable project.
BusinessEventRecords_Aggregate	String	A JSON aggregate. All event records for the latest Edit Project event.
Capital	Bool	When true, the project is capital.
Company_Descriptor	String	A description of the instance
Company_Href	String	A link to the instance
Company_Id	String	wid / id / reference id
Currency_Descriptor	String	A preview of the instance
Currency_Id	String	Id of the instance
Customer_Descriptor	String	A description of the instance
Customer_Href	String	A link to the instance
Customer_Id	String	wid / id / reference id
Description	String	The description of the project.
EndDate	Datetime	The end date for the approved project .
EstimatedBudget_Currency	String	The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. (Currency name)
EstimatedBudget_Value	Decimal	The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. (Value)
EstimatedRevenueSavings_Currency	String	The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Currency name)
EstimatedRevenueSavings_Value	Decimal	The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Value)
ExternalLink	String	The link to an external site.
ExternalProjectReference	String	Returns the external project reference.
Groups_Aggregate	String	A JSON aggregate. Identifies the project groups of a project. Project groups are used to organize projects for worktag prompting.
Href	String	A link to the instance
Id	String	Id of the instance
ImportanceRating_Descriptor	String	A description of the instance
ImportanceRating_Href	String	A link to the instance
ImportanceRating_Id	String	wid / id / reference id
InScope	String	A description of what is considered to be in scope for the project.
Inactive	Bool	When True, the current project or the associated project hierarchy becomes inactive.
IncludeProjectIDInName	Bool	When true, displays the ID in the Project name.
MeasuresOfSuccess	String	A description of what the project will be measured against to determine if it is successful.
Name	String	The approved project name.
Objective	String	A description of the desired outcome of the project.
OutOfScope	String	A description of what is considered to be out of scope for the project.
Overview	String	Project overview describing additional details about the project
Owner_Descriptor	String	A description of the instance
Owner_Href	String	A link to the instance
Owner_Id	String	wid / id / reference id
PercentComplete	Decimal	The percent complete for the project.
Priority_Descriptor	String	A description of the instance
Priority_Href	String	A link to the instance
Priority_Id	String	wid / id / reference id
ProbabilityOfSuccess	Decimal	Indicates the probability of the project's success.
ProblemStatement	String	A description of the problem to be resolved by the project.
ProjectDependencies_Aggregate	String	A JSON aggregate. Contains the list of projects defined as dependencies to the project.
RealizedRevenueSavings_Currency	String	The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Currency name)
RealizedRevenueSavings_Value	Decimal	The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. (Value)
RiskLevel_Descriptor	String	A description of the instance
RiskLevel_Href	String	A link to the instance
RiskLevel_Id	String	wid / id / reference id
StartDate	Datetime	The start date of the approved project.
Status_Descriptor	String	A description of the instance
Status_Href	String	A link to the instance
Status_Id	String	wid / id / reference id
SuccessRating_Descriptor	String	A description of the instance
SuccessRating_Href	String	A link to the instance
SuccessRating_Id	String	wid / id / reference id
TotalSavingsRemaining_Currency	String	The total amount of savings remaining in project currency. (Currency name)
TotalSavingsRemaining_Value	Decimal	The total amount of savings remaining in project currency. (Value)
Worktags_Aggregate	String	A JSON aggregate. Key words for projects to categorize transactions, such as Cost, Organization, etc.

Cmdlets for Workday