Jump to

• Request
• Response

ReadActivityOrAssignmentSpreadZip

get

/spread/activityOrAssignmentSpreadZip

Reads live spread data for Activity or ResourceAssignment and returns it as a ZIP file

Request

Query Parameters

• ActivitySpreadField(required): string
  Activity SpreadFields to load

  Example:

  ActualCost,ActualExpenseCost,ActualLaborCost,ActualLaborUnits,ActualMaterialCost,ActualNonLaborCost,ActualNonLaborUnits,ActualTotalCost,AtCompletionExpenseCost,AtCompletionLaborCost,AtCompletionLaborUnits,AtCompletionMaterialCost,AtCompletionNonLaborCost,AtCompletionNonLaborUnits,AtCompletionTotalCost,Baseline1ActualExpenseCost,Baseline1ActualLaborCost,Baseline1ActualLaborUnits,Baseline1ActualMaterialCost,Baseline1ActualNonLaborCost,Baseline1ActualNonLaborUnits,Baseline1ActualTotalCost,Baseline1PlannedExpenseCost,Baseline1PlannedLaborCost,Baseline1PlannedLaborUnits,Baseline1PlannedMaterialCost,Baseline1PlannedNonLaborCost,Baseline1PlannedNonLaborUnits,Baseline1PlannedTotalCost,BaselineActualExpenseCost,BaselineActualLaborCost,BaselineActualLaborUnits,BaselineActualMaterialCost,BaselineActualNonLaborCost,BaselineActualNonLaborUnits,BaselineActualTotalCost,BaselinePlannedExpenseCost,BaselinePlannedLaborCost,BaselinePlannedLaborUnits,BaselinePlannedMaterialCost,BaselinePlannedNonLaborCost,BaselinePlannedNonLaborUnits,BaselinePlannedTotalCost,EarnedValueCost,EarnedValueLaborUnits,EstimateAtCompletionCost,EstimateAtCompletionLaborUnits,EstimateToCompleteCost,EstimateToCompleteLaborUnits,PlannedExpenseCost,PlannedLaborCost,PlannedLaborUnits,PlannedMaterialCost,PlannedNonLaborCost,PlannedNonLaborUnits,PlannedTotalCost,PlannedValueCost,PlannedValueLaborUnits,RemainingExpenseCost,RemainingLaborCost,RemainingLaborUnits,RemainingLateExpenseCost,RemainingLateLaborCost,RemainingLateLaborUnits,RemainingLateMaterialCost,RemainingLateNonLaborCost,RemainingLateNonLaborUnits,RemainingLateTotalCost,RemainingMaterialCost,RemainingNonLaborCost,RemainingNonLaborUnits,RemainingTotalCost

• EndDate: string
  EndDate
• IncludeCumulative: string
  IncludeCumulative to load : Supported values - true, false
• PeriodType(required): string
  PeriodType to load

  Example:

  MONTH

• ProjectObjectId(required): string
  ProjectObjectId to load

  Example:

  4835

• ResourceAssignmentSpreadField(required): string
  Resource Assignment SpreadFields to load

  Example:

  ActualCost,ActualOvertimeCost,ActualOvertimeUnits,ActualRegularCost,ActualRegularUnits,ActualUnits,AtCompletionCost,AtCompletionUnits,PlannedCost,PlannedUnits,RemainingCost,RemainingLateCost,RemainingLateUnits,RemainingUnits,StaffedRemainingCost,StaffedRemainingLateCost,StaffedRemainingLateUnits,StaffedRemainingUnits,UnstaffedRemainingCost,UnstaffedRemainingLateCost,UnstaffedRemainingLateUnits,UnstaffedRemainingUnits,PeriodActualCost,PeriodActualUnits,PeriodAtCompletionCost,PeriodAtCompletionUnits

• StartDate: string
  StartDate
• Type(required): string
  Type of Spread

  Example:

  Activity Or ResourceAssignment

Header Parameters

• Authorization: string
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/zip

200 Response

ZIP file with spread JSON attached.

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

500 Response

Internal Server Error.

Back to Top