Jump to

• Request
• Response

Calculate Assignment Spread

post

/api/restapi/action/assignmentspread/calculate

Send a request to this endpoint to calculate the assignment spread of the selected or all assignments in a project for the input list of spread items in the specified 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

Request Body - application/json ()

Root Schema : ApiEntityCalcAssignmentSpreadInput

Type: object

Title: ApiEntityCalcAssignmentSpreadInput

Show Source

• assignmentIds: array assignmentIds
  The list of IDs for the assignments used in the spread calculations. If not provided, all assignments in the project will be used in the spread calculations.
• 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.
• cutoffDate: string (date-time)
  Cutoff date for the spread calculations. Populate if you want to cease the calculation of spreads beyond a specified date to speed up the processing of the job. Any values remaining after the cutoff date will be added as a lump sum in the cutoff date bucket. If not provided, all spreads with be calculated for the duration of the activity/assignment.
• 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", "YEARLY" ]

  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.

{
    "title":"ApiEntityCalcAssignmentSpreadInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "timescale":{
            "type":"string",
            "description":"Timescale for the spread calculation. If not provided, Daily will be used.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DAILY",
                "WEEKLY",
                "MONTHLY",
                "QUARTERLY",
                "YEARLY"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "isBaseline":{
            "type":"boolean",
            "description":"Indicates whether or not the spread calculation is for Earned Value baseline.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "cutoffDate":{
            "type":"string",
            "description":"Cutoff date for the spread calculations. Populate if you want to cease the calculation of spreads beyond a specified date to speed up the processing of the job. Any values remaining after the cutoff date will be added as a lump sum in the cutoff date bucket. If not provided, all spreads with be calculated for the duration of the activity/assignment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignmentIds":{
            "type":"array",
            "description":"The list of IDs for the assignments used in the spread calculations. If not provided, all assignments in the project will be used in the spread calculations.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "format":"int64",
                "exampleSetFlag":false,
                "types":[
                    "integer"
                ]
            },
            "types":[
                "array"
            ]
        },
        "assignmentSpreadItems":{
            "type":"array",
            "description":"An array of assignment spread items. If not provided, the default set Planned/Actual/Remaining/At Completion Units/Cost will be used.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ],
                "enum":[
                    "plannedUnits",
                    "plannedCost",
                    "actualUnits",
                    "actualCost",
                    "remainingUnits",
                    "remainingCost",
                    "atCompletionUnits",
                    "atCompletionCost",
                    "remainingLateUnits",
                    "remainingLateCost"
                ]
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : assignmentIds

Type: array

The list of IDs for the assignments used in the spread calculations. If not provided, all assignments in the project will be used in the spread calculations.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "description":"The list of IDs for the assignments used in the spread calculations. If not provided, all assignments in the project will be used in the spread calculations.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "format":"int64",
        "exampleSetFlag":false,
        "types":[
            "integer"
        ]
    },
    "types":[
        "array"
    ]
}

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", "plannedCost", "actualUnits", "actualCost", "remainingUnits", "remainingCost", "atCompletionUnits", "atCompletionCost", "remainingLateUnits", "remainingLateCost" ]

{
    "type":"array",
    "description":"An array of assignment spread items. If not provided, the default set Planned/Actual/Remaining/At Completion Units/Cost will be used.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ],
        "enum":[
            "plannedUnits",
            "plannedCost",
            "actualUnits",
            "actualCost",
            "remainingUnits",
            "remainingCost",
            "atCompletionUnits",
            "atCompletionCost",
            "remainingLateUnits",
            "remainingLateCost"
        ]
    },
    "types":[
        "array"
    ]
}

Examples

Select an example Calculate Assignment Spread using Defaults Calculate Assignment Spread for an Earned Value Baseline Project using a Monthly Timescale Calculate Assignment Spread for Selected Assignments using a Cutoff Date

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityScheduleJob

Type: object

Title: ApiEntityScheduleJob

Show Source

• 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.

{
    "title":"ApiEntityScheduleJob",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobKey":{
            "type":"integer",
            "description":"The unique identifier for a job.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

Back to Top