Schedule a Project
post
/api/restapi/action/scheduleProject
Send a request to this endpoint to schedule a project. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs.Schedule a project to determine a project timeline based on the constraints, relationships, and date types to which activities must adhere. The application's project scheduler will use the Critical path method algorithm to assign activity dates, calculate total float, and set the project critical path.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityProjectScheduleInput
Type:
object
Title:
Show Source
ApiEntityProjectScheduleInput
-
dataDate: string
(date-time)
The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually.
The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityScheduleJob
Type:
object
Title:
Show Source
ApiEntityScheduleJob
-
jobId: integer
(int64)
The unique identifier for the background service.
-
jobKey: integer
(int64)
The unique identifier for a job.
-
jobStatus: string
Allowed Values:
[ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]
The status of the background service. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
400 Response
Invalid input for the Action service.