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 component 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	Unique identifier for the project being edited.
Billable	Bool	Indicates whether the project is billable. When True, the project is considered billable.
BusinessEventRecords_Aggregate	String	List of all event records for the most recent project edit.
Capital	Bool	Indicates whether the project is classified as capital.
Company_Id	String	Unique identifier or reference ID for the company associated with the project.
Currency_Descriptor	String	Descriptive label for the currency used in the project.
Currency_Id	String	Unique identifier for the currency associated with the project.
Customer_Id	String	Unique identifier or reference ID for the customer associated with the project.
Description	String	Detailed description of the project.
EndDate	Datetime	The planned or approved end date of the project.
EstimatedBudget_Currency	String	Currency for the estimated budget allocated to the project.
EstimatedBudget_Value	Decimal	Estimated budget amount allocated to the project, expressed in the project currency.
EstimatedRevenueSavings_Currency	String	Currency for the estimated revenue (billable project) or savings (non-billable project).
EstimatedRevenueSavings_Value	Decimal	Estimated revenue (billable project) or savings (non-billable project), expressed in project currency.
ExternalLink	String	URL linking to an external site relevant to the project.
ExternalProjectReference	String	Reference to an external project related to this project.
Groups_Aggregate	String	List of project groups associated with the project, used for organizing worktags.
Href	String	URL linking to the project instance.
Id	String	Unique identifier for the specific instance of the project.
ImportanceRating_Id	String	Unique identifier or reference ID for the importance rating of the project.
InScope	String	Description of elements considered within the project's scope.
Inactive	Bool	Indicates whether the project or project hierarchy is inactive.
IncludeProjectIDInName	Bool	Determines whether the project ID is displayed in the project name.
MeasuresOfSuccess	String	Description of criteria used to determine project success.
Name	String	The approved name of the project.
Objective	String	Description of the project's intended outcome.
OutOfScope	String	Description of elements considered outside the project's scope.
Overview	String	Additional details describing the project's purpose and execution.
Owner_Id	String	Unique identifier or reference ID for the project owner.
PercentComplete	Decimal	Percentage of the project that has been completed.
Priority_Id	String	Unique identifier or reference ID for the project's priority level.
ProbabilityOfSuccess	Decimal	Estimated probability that the project will be successful.
ProblemStatement	String	Description of the issue the project aims to resolve.
ProjectDependencies_Aggregate	String	List of projects defined as dependencies for this project.
RealizedRevenueSavings_Currency	String	Currency for actual revenue (billable project) or savings (non-billable project).
RealizedRevenueSavings_Value	Decimal	Actual revenue (billable project) or savings (non-billable project), expressed in project currency.
RiskLevel_Id	String	Unique identifier or reference ID for the risk level assigned to the project.
StartDate	Datetime	The planned or approved start date of the project.
Status_Id	String	Unique identifier or reference ID for the current status of the project.
SuccessRating_Id	String	Unique identifier or reference ID for the success rating of the project.
Worktags_Aggregate	String	Key words for projects to categorize transactions, such as Cost, Organization, etc.

Result Set Columns

Name	Type	Description
Billable	Bool	Indicates whether the project is billable. When True, the project is considered billable.
BusinessEventRecords_Aggregate	String	List of all event records for the most recent project edit.
Capital	Bool	Indicates whether the project is classified as capital.
Company_Descriptor	String	Descriptive label for the company associated with the project.
Company_Href	String	URL linking to the company instance.
Company_Id	String	Unique identifier or reference ID for the company associated with the project.
Currency_Descriptor	String	Descriptive label for the currency used in the project.
Currency_Id	String	Unique identifier for the currency associated with the project.
Customer_Descriptor	String	Descriptive label for the customer associated with the project.
Customer_Href	String	URL linking to the customer instance.
Customer_Id	String	Unique identifier or reference ID for the customer associated with the project.
Description	String	Detailed description of the project.
EndDate	Datetime	The planned or approved end date of the project.
EstimatedBudget_Currency	String	Currency for the estimated budget allocated to the project.
EstimatedBudget_Value	Decimal	Estimated budget amount allocated to the project, expressed in the project currency.
EstimatedRevenueSavings_Currency	String	Currency for the estimated revenue (billable project) or savings (non-billable project).
EstimatedRevenueSavings_Value	Decimal	Estimated revenue (billable project) or savings (non-billable project), expressed in project currency.
ExternalLink	String	URL linking to an external site relevant to the project.
ExternalProjectReference	String	Reference to an external project related to this project.
Groups_Aggregate	String	List of project groups associated with the project, used for organizing worktags.
Href	String	URL linking to the project instance.
Id	String	Unique identifier for the specific instance of the project.
ImportanceRating_Descriptor	String	Descriptive label for the project's importance rating.
ImportanceRating_Href	String	URL link to the importance rating instance.
ImportanceRating_Id	String	Unique identifier or reference ID for the project's importance rating.
InScope	String	Description of elements considered within the project's scope.
Inactive	Bool	Indicates whether the project or project hierarchy is inactive.
IncludeProjectIDInName	Bool	Determines whether the project ID is displayed in the project name.
MeasuresOfSuccess	String	Description of criteria used to determine project success.
Name	String	The approved name of the project.
Objective	String	Description of the project's intended outcome.
OutOfScope	String	Description of elements considered outside the project's scope.
Overview	String	Additional details describing the project's purpose and execution.
Owner_Descriptor	String	Descriptive label for the project owner.
Owner_Href	String	URL link to the project owner instance.
Owner_Id	String	Unique identifier or reference ID for the project owner.
PercentComplete	Decimal	Percentage of the project that has been completed.
Priority_Descriptor	String	Descriptive label for the project's priority level.
Priority_Href	String	URL link to the priority level instance.
Priority_Id	String	Unique identifier or reference ID for the project's priority level.
ProbabilityOfSuccess	Decimal	Estimated probability that the project will be successful.
ProblemStatement	String	Description of the issue the project aims to resolve.
ProjectDependencies_Aggregate	String	List of projects defined as dependencies for this project.
RealizedRevenueSavings_Currency	String	Currency for actual revenue (billable project) or savings (non-billable project).
RealizedRevenueSavings_Value	Decimal	Actual revenue (billable project) or savings (non-billable project), expressed in project currency.
RiskLevel_Descriptor	String	Descriptive label for the project's risk level.
RiskLevel_Href	String	URL link to the risk level instance.
RiskLevel_Id	String	Unique identifier or reference ID for the project's risk level.
StartDate	Datetime	The planned or approved start date of the project.
Status_Descriptor	String	Descriptive label for the project's current status.
Status_Href	String	URL link to the status instance.
Status_Id	String	Unique identifier or reference ID for the current status of the project.
SuccessRating_Descriptor	String	Descriptive label for the project's success rating.
SuccessRating_Href	String	URL link to the success rating instance.
SuccessRating_Id	String	Unique identifier or reference ID for the project's success rating.
TotalSavingsRemaining_Currency	String	Currency for the total amount of savings remaining in the project.
TotalSavingsRemaining_Value	Decimal	Total amount of savings remaining in project currency.
Worktags_Aggregate	String	Key words for projects to categorize transactions, such as Cost, Organization, etc.