Calculate Assignment Spread
post
/api/restapi/action/assignmentspread/calculate
Send a request to this endpoint to calculate the assignment spread of all assignments in a project for the input list of spread items in the Daily timescale. This endpoint returns a job ID upon request execution. Send a request to the View Job Status endpoint to monitor the status of the scheduled jobs. Once the job is complete, download the spread result using the Download Activity/Assignment Spread endpoint.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityCalcAssignmentSpreadInput
Type:
object
Title:
Show Source
ApiEntityCalcAssignmentSpreadInput
-
assignmentSpreadItems: array
assignmentSpreadItems
An array of assignment spread items. If not provided, the default set Planned/Actual/Remaining/At Completion Units/Cost will be used.
-
isBaseline: boolean
Indicates whether or not the spread calculation is for Earned Value baseline.
-
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. -
projectId: integer
(int64)
The unique identifier for the project.
-
timescale: string
Allowed Values:
[ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY" ]
Timescale for the spread calculation. If not provided, Daily will be used. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : assignmentSpreadItems
Type:
array
An array of assignment spread items. If not provided, the default set Planned/Actual/Remaining/At Completion Units/Cost will be used.
Show Source
-
Array of:
string
Allowed Values:
[ "plannedUnits", "actualUnits", "remainingUnits", "atCompletionUnits", "plannedCost", "actualCost", "remainingCost", "atCompletionCost" ]
Examples
Back to Top
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.