| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionNo} |
|---|
"use strict";
export class EstimateRevision {
/** @param {{EstimateRevisionID?:number,RfpDocumentID?:number,RevisionNo?:number,Label?:string,Reason?:string,Trigger?:string,TotalAmount?:number,LineCount?:number,CreatedBy?:string,CreatedAt?:string,SnapshotJson?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
EstimateRevisionID;
/** @type {number} */
RfpDocumentID;
/** @type {number} */
RevisionNo;
/** @type {string} */
Label;
/** @type {string} */
Reason;
/** @type {string} */
Trigger;
/** @type {number} */
TotalAmount;
/** @type {number} */
LineCount;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {string} */
SnapshotJson;
}
export class ResourcedPosition {
/** @param {{PositionTag?:string,Hours?:number,CrewSize?:number,Utilization?:number,FixedDays?:number,Headcount?:number,SourceReference?:string,Notes?:string,IsInCatalog?:boolean,ContactID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PositionTag;
/** @type {?number} */
Hours;
/** @type {?number} */
CrewSize;
/** @type {?number} */
Utilization;
/** @type {?number} */
FixedDays;
/** @type {?number} */
Headcount;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {boolean} */
IsInCatalog;
/** @type {?number} */
ContactID;
}
export class ResourcedEquipment {
/** @param {{EquipmentID?:number,EquipmentName?:string,MakeModel?:string,Quantity?:number,DurationDays?:number,Utilization?:number,FixedDays?:number,SourceReference?:string,Notes?:string,IsInCatalog?:boolean,SuggestedEquipmentID?:number,SuggestedEquipmentName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
EquipmentID;
/** @type {string} */
EquipmentName;
/** @type {string} */
MakeModel;
/** @type {?number} */
Quantity;
/** @type {?number} */
DurationDays;
/** @type {?number} */
Utilization;
/** @type {?number} */
FixedDays;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {boolean} */
IsInCatalog;
/** @type {number} */
SuggestedEquipmentID;
/** @type {string} */
SuggestedEquipmentName;
}
export class ResourcedMaterial {
/** @param {{MaterialID?:number,MaterialName?:string,MakeModel?:string,Quantity?:number,QuantityPerUnit?:number,Unit?:string,SourceReference?:string,Notes?:string,IsInCatalog?:boolean,SuggestedMaterialID?:number,SuggestedMaterialName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
MaterialID;
/** @type {string} */
MaterialName;
/** @type {string} */
MakeModel;
/** @type {?number} */
Quantity;
/** @type {?number} */
QuantityPerUnit;
/** @type {string} */
Unit;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {boolean} */
IsInCatalog;
/** @type {number} */
SuggestedMaterialID;
/** @type {string} */
SuggestedMaterialName;
}
export class TaskResourcing {
/** @param {{Positions?:ResourcedPosition[],Equipment?:ResourcedEquipment[],Materials?:ResourcedMaterial[],ResourcedForQuantity?:number,ProductionRatePerDay?:number,FixedDays?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResourcedPosition[]} */
Positions = [];
/** @type {ResourcedEquipment[]} */
Equipment = [];
/** @type {ResourcedMaterial[]} */
Materials = [];
/** @type {?number} */
ResourcedForQuantity;
/** @type {?number} */
ProductionRatePerDay;
/** @type {?number} */
FixedDays;
}
export class WorkPackageSpecRef {
/** @param {{Section?:string,Title?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Section;
/** @type {string} */
Title;
}
export class TaskWorkPackage {
/** @param {{Scope?:string,LimitsOfWork?:string,SpecRefs?:WorkPackageSpecRef[],Constraints?:string[],HoldPoints?:string[],DefinitionOfDone?:string[],SafetyNote?:string,RfpRef?:string,Confidence?:number,SpecBook?:string,UserScope?:string,DodRemoved?:number[],DodExtra?:string[],UserEdited?:boolean,DodChecked?:string[],RedraftNote?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Scope;
/** @type {string} */
LimitsOfWork;
/** @type {WorkPackageSpecRef[]} */
SpecRefs = [];
/** @type {string[]} */
Constraints = [];
/** @type {string[]} */
HoldPoints = [];
/** @type {string[]} */
DefinitionOfDone = [];
/** @type {string} */
SafetyNote;
/** @type {string} */
RfpRef;
/** @type {?number} */
Confidence;
/** @type {string} */
SpecBook;
/** @type {string} */
UserScope;
/** @type {number[]} */
DodRemoved = [];
/** @type {string[]} */
DodExtra = [];
/** @type {boolean} */
UserEdited;
/** @type {string[]} */
DodChecked = [];
/** @type {string} */
RedraftNote;
}
export class ProposedTask {
/** @param {{Seq?:number,Name?:string,Category?:string,Quantity?:number,Unit?:string,SourceItemNumber?:string,SourceReference?:string,Notes?:string,Resourcing?:TaskResourcing,DurationDays?:number,DependsOn?:number[],EstimatedStartDate?:string,EstimatedEndDate?:string,WorkPackage?:TaskWorkPackage,CreatedJobID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Seq;
/** @type {string} */
Name;
/** @type {string} */
Category;
/** @type {?number} */
Quantity;
/** @type {string} */
Unit;
/** @type {string} */
SourceItemNumber;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {TaskResourcing} */
Resourcing;
/** @type {?number} */
DurationDays;
/** @type {number[]} */
DependsOn = [];
/** @type {?string} */
EstimatedStartDate;
/** @type {?string} */
EstimatedEndDate;
/** @type {TaskWorkPackage} */
WorkPackage;
/** @type {?number} */
CreatedJobID;
}
export class AddendaChange {
/** @param {{ChangeId?:string,ChangeType?:string,TargetSeq?:number,ItemNumber?:string,ItemName?:string,Field?:string,OldValue?:string,NewValue?:string,Description?:string,Status?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ChangeId;
/** @type {string} */
ChangeType;
/** @type {?number} */
TargetSeq;
/** @type {string} */
ItemNumber;
/** @type {string} */
ItemName;
/** @type {string} */
Field;
/** @type {string} */
OldValue;
/** @type {string} */
NewValue;
/** @type {string} */
Description;
/** @type {string} */
Status;
}
export class AddendaChangeSet {
/** @param {{ChangeSetId?:string,SourceRfpDocumentID?:number,SourceFileName?:string,DocumentType?:string,ExtractedAtUtc?:string,Summary?:string,Changes?:AddendaChange[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ChangeSetId;
/** @type {number} */
SourceRfpDocumentID;
/** @type {string} */
SourceFileName;
/** @type {string} */
DocumentType;
/** @type {?string} */
ExtractedAtUtc;
/** @type {string} */
Summary;
/** @type {AddendaChange[]} */
Changes = [];
}
export class WageClassification {
/** @param {{Title?:string,BaseRate?:number,FringeRate?:number,ParishNote?:string,SourceLine?:string,BenchmarkFringeRate?:number,FringeCompareNote?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Title;
/** @type {?number} */
BaseRate;
/** @type {?number} */
FringeRate;
/** @type {string} */
ParishNote;
/** @type {string} */
SourceLine;
/** @type {?number} */
BenchmarkFringeRate;
/** @type {string} */
FringeCompareNote;
}
export class WageDeterminationResult {
/** @param {{SourceRfpDocumentID?:number,SourceFileName?:string,WdNumber?:string,ExtractedAtUtc?:string,Classifications?:WageClassification[],Source?:string,IsTrustworthy?:boolean,ExecutiveOrderFloor?:number,PublishedDate?:string,ProjectParish?:string,Warnings?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SourceRfpDocumentID;
/** @type {string} */
SourceFileName;
/** @type {string} */
WdNumber;
/** @type {?string} */
ExtractedAtUtc;
/** @type {WageClassification[]} */
Classifications = [];
/** @type {string} */
Source;
/** @type {boolean} */
IsTrustworthy;
/** @type {?number} */
ExecutiveOrderFloor;
/** @type {string} */
PublishedDate;
/** @type {string} */
ProjectParish;
/** @type {string[]} */
Warnings = [];
}
export class ProjectProposal {
/** @param {{RfpDocumentID?:number,Mode?:string,ProjectID?:number,ChangeOrderID?:number,ProjectName?:string,ClientName?:string,ProjectType?:string,ProjectLocation?:string,Scope?:string,ProjectDescription?:string,ContractDurationDays?:number,BidDueDate?:string,EstimatedStartDate?:string,EstimatedEndDate?:string,Tasks?:ProposedTask[],PendingAddendaDiffs?:AddendaChangeSet[],WageDeterminations?:WageDeterminationResult[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RfpDocumentID;
/** @type {string} */
Mode;
/** @type {?number} */
ProjectID;
/** @type {?number} */
ChangeOrderID;
/** @type {string} */
ProjectName;
/** @type {string} */
ClientName;
/** @type {string} */
ProjectType;
/** @type {string} */
ProjectLocation;
/** @type {string} */
Scope;
/** @type {string} */
ProjectDescription;
/** @type {?number} */
ContractDurationDays;
/** @type {string} */
BidDueDate;
/** @type {?string} */
EstimatedStartDate;
/** @type {?string} */
EstimatedEndDate;
/** @type {ProposedTask[]} */
Tasks = [];
/** @type {AddendaChangeSet[]} */
PendingAddendaDiffs = [];
/** @type {WageDeterminationResult[]} */
WageDeterminations = [];
}
export class EstimateSettingsView {
/** @param {{RfpEstimateID?:number,StartDate?:string,DeadlineDate?:string,WorkdaysPerWeek?:number,HoursPerDay?:number,WeatherPct?:number,OhpPct?:number,ContingencyPct?:number,BondPct?:number,Holidays?:string[],AppliedStartDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RfpEstimateID;
/** @type {?string} */
StartDate;
/** @type {?string} */
DeadlineDate;
/** @type {number} */
WorkdaysPerWeek;
/** @type {number} */
HoursPerDay;
/** @type {number} */
WeatherPct;
/** @type {number} */
OhpPct;
/** @type {number} */
ContingencyPct;
/** @type {number} */
BondPct;
/** @type {string[]} */
Holidays = [];
/** @type {?string} */
AppliedStartDate;
}
export class SpecRefView {
/** @param {{Section?:string,Title?:string,Url?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Section;
/** @type {string} */
Title;
/** @type {string} */
Url;
}
export class DodItemView {
/** @param {{Key?:string,Text?:string,Checked?:boolean,Source?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Text;
/** @type {boolean} */
Checked;
/** @type {string} */
Source;
}
export class WorkPackageView {
/** @param {{HasPackage?:boolean,Scope?:string,LimitsOfWork?:string,SpecRefs?:SpecRefView[],Constraints?:string[],HoldPoints?:string[],Dod?:DodItemView[],SafetyNote?:string,Provenance?:string,SpecBook?:string,UserEdited?:boolean,RedraftNote?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
HasPackage;
/** @type {string} */
Scope;
/** @type {string} */
LimitsOfWork;
/** @type {SpecRefView[]} */
SpecRefs = [];
/** @type {string[]} */
Constraints = [];
/** @type {string[]} */
HoldPoints = [];
/** @type {DodItemView[]} */
Dod = [];
/** @type {string} */
SafetyNote;
/** @type {string} */
Provenance;
/** @type {string} */
SpecBook;
/** @type {boolean} */
UserEdited;
/** @type {string} */
RedraftNote;
}
export class EstimateCrewLineView {
/** @param {{Role?:string,Hours?:number,StHours?:number,OtHours?:number,HasOt?:boolean,PremiumApplied?:boolean,NeedsRate?:boolean,RateKey?:string,Chip?:string,Rrop?:number,StCost?:number,OtCost?:number,Cost?:number,FringeCost?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Role;
/** @type {number} */
Hours;
/** @type {number} */
StHours;
/** @type {number} */
OtHours;
/** @type {boolean} */
HasOt;
/** @type {boolean} */
PremiumApplied;
/** @type {boolean} */
NeedsRate;
/** @type {string} */
RateKey;
/** @type {string} */
Chip;
/** @type {?number} */
Rrop;
/** @type {?number} */
StCost;
/** @type {?number} */
OtCost;
/** @type {?number} */
Cost;
/** @type {?number} */
FringeCost;
}
export class EstimateEquipmentLineView {
/** @param {{Name?:string,Quantity?:number,Rate?:number,NeedsRate?:boolean,MobCost?:number,Cost?:number,IsAvailabilityTracked?:boolean,IsOwned?:boolean,AvailabilityLabel?:string,FreedFromProject?:string,AvailableFrom?:string,RateKey?:string,Chip?:string,RentalExplain?:string,UsageDays?:number,BilledDays?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {number} */
Quantity;
/** @type {?number} */
Rate;
/** @type {boolean} */
NeedsRate;
/** @type {number} */
MobCost;
/** @type {number} */
Cost;
/** @type {boolean} */
IsAvailabilityTracked;
/** @type {boolean} */
IsOwned;
/** @type {string} */
AvailabilityLabel;
/** @type {string} */
FreedFromProject;
/** @type {?string} */
AvailableFrom;
/** @type {string} */
RateKey;
/** @type {string} */
Chip;
/** @type {string} */
RentalExplain;
/** @type {number} */
UsageDays;
/** @type {number} */
BilledDays;
}
export class EstimateMaterialLineView {
/** @param {{Name?:string,Quantity?:number,Unit?:string,Rate?:number,NeedsRate?:boolean,Cost?:number,RateKey?:string,Chip?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {number} */
Quantity;
/** @type {string} */
Unit;
/** @type {?number} */
Rate;
/** @type {boolean} */
NeedsRate;
/** @type {number} */
Cost;
/** @type {string} */
RateKey;
/** @type {string} */
Chip;
}
export class EstimateSubcontractView {
/** @param {{EstimateSubcontractID?:number,TaskSeq?:number,Vendor?:string,Amount?:number,Scope?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
EstimateSubcontractID;
/** @type {number} */
TaskSeq;
/** @type {string} */
Vendor;
/** @type {number} */
Amount;
/** @type {string} */
Scope;
}
export class EstimateJobView {
/** @param {{Seq?:number,WorkPackage?:WorkPackageView,ItemNo?:string,Name?:string,Category?:string,SourceRef?:string,Unit?:string,Quantity?:number,PatternCode?:string,Workdays?:number,HoursPerDay?:number,IsNight?:boolean,WeeklyHours?:number,OtFraction?:number,Days?:number,EffectiveProdPerDay?:number,CrewPremiumApplied?:boolean,CrewCost?:number,FringeCost?:number,EquipmentCost?:number,MaterialCost?:number,SubcontractCost?:number,Direct?:number,PricingBasis?:string,PricingRuleId?:string,PricingBandP25?:number,PricingBandP75?:number,PricingBandN?:number,PricingBandLabel?:string,BenchmarkUnitPrice?:number,ReferencePrice?:number,ReferenceRangeMin?:number,ReferenceRangeMax?:number,ReferenceN?:number,ReferenceDate?:string,ReferenceBasis?:string,ReferenceUrl?:string,Crew?:EstimateCrewLineView[],Equipment?:EstimateEquipmentLineView[],Materials?:EstimateMaterialLineView[],Subcontracts?:EstimateSubcontractView[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Seq;
/** @type {WorkPackageView} */
WorkPackage;
/** @type {string} */
ItemNo;
/** @type {string} */
Name;
/** @type {string} */
Category;
/** @type {string} */
SourceRef;
/** @type {string} */
Unit;
/** @type {number} */
Quantity;
/** @type {string} */
PatternCode;
/** @type {number} */
Workdays;
/** @type {number} */
HoursPerDay;
/** @type {boolean} */
IsNight;
/** @type {number} */
WeeklyHours;
/** @type {number} */
OtFraction;
/** @type {number} */
Days;
/** @type {?number} */
EffectiveProdPerDay;
/** @type {boolean} */
CrewPremiumApplied;
/** @type {number} */
CrewCost;
/** @type {number} */
FringeCost;
/** @type {number} */
EquipmentCost;
/** @type {number} */
MaterialCost;
/** @type {number} */
SubcontractCost;
/** @type {number} */
Direct;
/** @type {string} */
PricingBasis;
/** @type {string} */
PricingRuleId;
/** @type {?number} */
PricingBandP25;
/** @type {?number} */
PricingBandP75;
/** @type {?number} */
PricingBandN;
/** @type {string} */
PricingBandLabel;
/** @type {?number} */
BenchmarkUnitPrice;
/** @type {?number} */
ReferencePrice;
/** @type {?number} */
ReferenceRangeMin;
/** @type {?number} */
ReferenceRangeMax;
/** @type {?number} */
ReferenceN;
/** @type {?string} */
ReferenceDate;
/** @type {string} */
ReferenceBasis;
/** @type {string} */
ReferenceUrl;
/** @type {EstimateCrewLineView[]} */
Crew = [];
/** @type {EstimateEquipmentLineView[]} */
Equipment = [];
/** @type {EstimateMaterialLineView[]} */
Materials = [];
/** @type {EstimateSubcontractView[]} */
Subcontracts = [];
}
export class BidScheduleLine {
/** @param {{ItemNo?:string,Description?:string,Unit?:string,Quantity?:number,UnitPrice?:number,Extension?:number,PricingBasis?:string,PricingRuleId?:string,PricingBandP25?:number,PricingBandP75?:number,PricingBandN?:number,PricingBandLabel?:string,BenchmarkDeltaPct?:number,BenchmarkFlagged?:boolean,BenchmarkBasis?:string,Provenance?:string,ProvenanceNote?:string,UnpricedResources?:number,TotalResources?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ItemNo;
/** @type {string} */
Description;
/** @type {string} */
Unit;
/** @type {number} */
Quantity;
/** @type {number} */
UnitPrice;
/** @type {number} */
Extension;
/** @type {string} */
PricingBasis;
/** @type {string} */
PricingRuleId;
/** @type {?number} */
PricingBandP25;
/** @type {?number} */
PricingBandP75;
/** @type {?number} */
PricingBandN;
/** @type {string} */
PricingBandLabel;
/** @type {?number} */
BenchmarkDeltaPct;
/** @type {boolean} */
BenchmarkFlagged;
/** @type {string} */
BenchmarkBasis;
/** @type {string} */
Provenance;
/** @type {string} */
ProvenanceNote;
/** @type {number} */
UnpricedResources;
/** @type {number} */
TotalResources;
}
export class EstimateVarianceLine {
/** @param {{Seq?:number,ItemNo?:string,Name?:string,Unit?:string,Quantity?:number,OurUnitPrice?:number,OurTotal?:number,BenchmarkUnitPrice?:number,MarketTotal?:number,DeltaPct?:number,RateMin?:number,RateMax?:number,SampleSize?:number,OutsideRange?:boolean,IsFloor?:boolean,IsLump?:boolean,Severity?:string,Adopted?:boolean,Note?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Seq;
/** @type {string} */
ItemNo;
/** @type {string} */
Name;
/** @type {string} */
Unit;
/** @type {number} */
Quantity;
/** @type {number} */
OurUnitPrice;
/** @type {number} */
OurTotal;
/** @type {number} */
BenchmarkUnitPrice;
/** @type {number} */
MarketTotal;
/** @type {number} */
DeltaPct;
/** @type {?number} */
RateMin;
/** @type {?number} */
RateMax;
/** @type {?number} */
SampleSize;
/** @type {?boolean} */
OutsideRange;
/** @type {boolean} */
IsFloor;
/** @type {boolean} */
IsLump;
/** @type {string} */
Severity;
/** @type {boolean} */
Adopted;
/** @type {string} */
Note;
}
export class EstimateVarianceView {
/** @param {{Lines?:EstimateVarianceLine[],ItemsTotal?:number,ItemsBenchmarked?:number,CoverageValuePct?:number,OursTotal?:number,MarketTotal?:number,AggregateDeltaPct?:number,FlooredCount?:number,LumpCount?:number,WatchCount?:number,OutlierCount?:number,CriticalCount?:number,Note?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {EstimateVarianceLine[]} */
Lines = [];
/** @type {number} */
ItemsTotal;
/** @type {number} */
ItemsBenchmarked;
/** @type {number} */
CoverageValuePct;
/** @type {number} */
OursTotal;
/** @type {number} */
MarketTotal;
/** @type {?number} */
AggregateDeltaPct;
/** @type {number} */
FlooredCount;
/** @type {number} */
LumpCount;
/** @type {number} */
WatchCount;
/** @type {number} */
OutlierCount;
/** @type {number} */
CriticalCount;
/** @type {string} */
Note;
}
export class IndicativeLine {
/** @param {{Seq?:number,ItemNo?:string,Name?:string,Unit?:string,Quantity?:number,Source?:string,UnitPrice?:number,LineTotal?:number,PricePoint?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Seq;
/** @type {string} */
ItemNo;
/** @type {string} */
Name;
/** @type {string} */
Unit;
/** @type {number} */
Quantity;
/** @type {string} */
Source;
/** @type {number} */
UnitPrice;
/** @type {number} */
LineTotal;
/** @type {string} */
PricePoint;
}
export class IndicativeBidView {
/** @param {{Lines?:IndicativeLine[],BottomUpCount?:number,BottomUpTotal?:number,BenchmarkCount?:number,BenchmarkTotal?:number,UncoveredCount?:number,UncoveredFloorTotal?:number,IndicativeTotal?:number,FloorTotal?:number,Note?:string,Posture?:string,AggressiveTotal?:number,MarketTotal?:number,PremiumTotal?:number,NoDistributionCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {IndicativeLine[]} */
Lines = [];
/** @type {number} */
BottomUpCount;
/** @type {number} */
BottomUpTotal;
/** @type {number} */
BenchmarkCount;
/** @type {number} */
BenchmarkTotal;
/** @type {number} */
UncoveredCount;
/** @type {number} */
UncoveredFloorTotal;
/** @type {number} */
IndicativeTotal;
/** @type {number} */
FloorTotal;
/** @type {string} */
Note;
/** @type {string} */
Posture;
/** @type {number} */
AggressiveTotal;
/** @type {number} */
MarketTotal;
/** @type {number} */
PremiumTotal;
/** @type {number} */
NoDistributionCount;
}
export class BidExposureLine {
/** @param {{ItemNo?:string,Description?:string,Provenance?:string,Extension?:number,CumulativePct?:number,Note?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ItemNo;
/** @type {string} */
Description;
/** @type {string} */
Provenance;
/** @type {number} */
Extension;
/** @type {number} */
CumulativePct;
/** @type {string} */
Note;
}
export class BidOwnershipView {
/** @param {{OwnTotal?:number,BorrowedTotal?:number,UnknownFloorTotal?:number,ScheduleTotal?:number,OwnCount?:number,BorrowedCount?:number,UnknownCount?:number,OwnPct?:number,TopExposure?:BidExposureLine[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
OwnTotal;
/** @type {number} */
BorrowedTotal;
/** @type {number} */
UnknownFloorTotal;
/** @type {number} */
ScheduleTotal;
/** @type {number} */
OwnCount;
/** @type {number} */
BorrowedCount;
/** @type {number} */
UnknownCount;
/** @type {number} */
OwnPct;
/** @type {BidExposureLine[]} */
TopExposure = [];
}
export class EstimateSummaryView {
/** @param {{Direct?:number,OhpPct?:number,OhpAmount?:number,BondPct?:number,BondAmount?:number,ContingencyPct?:number,ContingencyAmount?:number,BidTotal?:number,LoadFactor?:number,MarginPct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Direct;
/** @type {number} */
OhpPct;
/** @type {number} */
OhpAmount;
/** @type {number} */
BondPct;
/** @type {number} */
BondAmount;
/** @type {number} */
ContingencyPct;
/** @type {number} */
ContingencyAmount;
/** @type {number} */
BidTotal;
/** @type {number} */
LoadFactor;
/** @type {number} */
MarginPct;
}
export class EstimateTimingView {
/** @param {{TotalWorkdays?:number,CalendarDays?:number,Finish?:string,Feasible?:boolean,Deadline?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TotalWorkdays;
/** @type {number} */
CalendarDays;
/** @type {string} */
Finish;
/** @type {boolean} */
Feasible;
/** @type {?string} */
Deadline;
}
export class EstimateReviewItemView {
/** @param {{TaskSeq?:number,TaskName?:string,Reason?:string,Status?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TaskSeq;
/** @type {string} */
TaskName;
/** @type {string} */
Reason;
/** @type {string} */
Status;
}
export class EstimatingView {
/** @param {{RfpDocumentID?:number,ProjectName?:string,ClientName?:string,BidDueDate?:string,ProjectType?:string,Settings?:EstimateSettingsView,Jobs?:EstimateJobView[],Schedule?:BidScheduleLine[],ScheduleTotal?:number,Variance?:EstimateVarianceView,Indicative?:IndicativeBidView,Ownership?:BidOwnershipView,Summary?:EstimateSummaryView,Timing?:EstimateTimingView,NeedsRateCount?:number,NeedsRateKeys?:string[],ReviewItems?:EstimateReviewItemView[],NeedsReviewCount?:number,CanApprove?:boolean,CanSeePay?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RfpDocumentID;
/** @type {string} */
ProjectName;
/** @type {string} */
ClientName;
/** @type {string} */
BidDueDate;
/** @type {string} */
ProjectType;
/** @type {EstimateSettingsView} */
Settings;
/** @type {EstimateJobView[]} */
Jobs = [];
/** @type {BidScheduleLine[]} */
Schedule = [];
/** @type {number} */
ScheduleTotal;
/** @type {EstimateVarianceView} */
Variance;
/** @type {IndicativeBidView} */
Indicative;
/** @type {BidOwnershipView} */
Ownership;
/** @type {EstimateSummaryView} */
Summary;
/** @type {EstimateTimingView} */
Timing;
/** @type {number} */
NeedsRateCount;
/** @type {string[]} */
NeedsRateKeys = [];
/** @type {EstimateReviewItemView[]} */
ReviewItems = [];
/** @type {number} */
NeedsReviewCount;
/** @type {boolean} */
CanApprove;
/** @type {boolean} */
CanSeePay;
}
export class EstimateSnapshot {
/** @param {{TakenAtUtc?:string,Proposal?:ProjectProposal,View?:EstimatingView}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
TakenAtUtc;
/** @type {ProjectProposal} */
Proposal;
/** @type {EstimatingView} */
View;
}
export class EstimateRevisionGetResponse {
/** @param {{ResponseStatus?:ResponseStatus,Revision?:EstimateRevision,Snapshot?:EstimateSnapshot}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {EstimateRevision} */
Revision;
/** @type {EstimateSnapshot} */
Snapshot;
}
export class EstimateRevisionGetRequest {
/** @param {{RfpDocumentUID?:string,RevisionNo?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RfpDocumentUID;
/** @type {number} */
RevisionNo;
}
JavaScript EstimateRevisionGetRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionNo} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Revision:
{
EstimateRevisionID: 0,
RfpDocumentID: 0,
RevisionNo: 0,
Label: String,
Reason: String,
Trigger: String,
TotalAmount: 0,
LineCount: 0,
CreatedBy: String,
CreatedAt: 0001-01-01,
SnapshotJson: String
},
Snapshot:
{
TakenAtUtc: 0001-01-01,
Proposal:
{
RfpDocumentID: 0,
Mode: String,
ProjectID: 0,
ChangeOrderID: 0,
ProjectName: String,
ClientName: String,
ProjectType: String,
ProjectLocation: String,
Scope: String,
ProjectDescription: String,
ContractDurationDays: 0,
BidDueDate: String,
EstimatedStartDate: 0001-01-01,
EstimatedEndDate: 0001-01-01,
Tasks:
[
{
Seq: 0,
Name: String,
Category: String,
Quantity: 0,
Unit: String,
SourceItemNumber: String,
SourceReference: String,
Notes: String,
Resourcing:
{
Positions:
[
{
PositionTag: String,
Hours: 0,
CrewSize: 0,
Utilization: 0,
FixedDays: 0,
Headcount: 0,
SourceReference: String,
Notes: String,
IsInCatalog: False,
ContactID: 0
}
],
Equipment:
[
{
EquipmentID: 0,
EquipmentName: String,
MakeModel: String,
Quantity: 0,
DurationDays: 0,
Utilization: 0,
FixedDays: 0,
SourceReference: String,
Notes: String,
IsInCatalog: False,
SuggestedEquipmentID: 0,
SuggestedEquipmentName: String
}
],
Materials:
[
{
MaterialID: 0,
MaterialName: String,
MakeModel: String,
Quantity: 0,
QuantityPerUnit: 0,
Unit: String,
SourceReference: String,
Notes: String,
IsInCatalog: False,
SuggestedMaterialID: 0,
SuggestedMaterialName: String
}
],
ResourcedForQuantity: 0,
ProductionRatePerDay: 0,
FixedDays: 0
},
DurationDays: 0,
DependsOn:
[
0
],
EstimatedStartDate: 0001-01-01,
EstimatedEndDate: 0001-01-01,
WorkPackage:
{
Scope: String,
LimitsOfWork: String,
SpecRefs:
[
{
Section: String,
Title: String
}
],
Constraints:
[
String
],
HoldPoints:
[
String
],
DefinitionOfDone:
[
String
],
SafetyNote: String,
RfpRef: String,
Confidence: 0,
SpecBook: String,
UserScope: String,
DodRemoved:
[
0
],
DodExtra:
[
String
],
UserEdited: False,
DodChecked:
[
String
],
RedraftNote: String
},
CreatedJobID: 0
}
],
PendingAddendaDiffs:
[
{
ChangeSetId: String,
SourceRfpDocumentID: 0,
SourceFileName: String,
DocumentType: String,
ExtractedAtUtc: 0001-01-01,
Summary: String,
Changes:
[
{
ChangeId: String,
ChangeType: String,
TargetSeq: 0,
ItemNumber: String,
ItemName: String,
Field: String,
OldValue: String,
NewValue: String,
Description: String,
Status: String
}
]
}
],
WageDeterminations:
[
{
SourceRfpDocumentID: 0,
SourceFileName: String,
WdNumber: String,
ExtractedAtUtc: 0001-01-01,
Classifications:
[
{
Title: String,
BaseRate: 0,
FringeRate: 0,
ParishNote: String,
SourceLine: String,
BenchmarkFringeRate: 0,
FringeCompareNote: String
}
],
Source: String,
IsTrustworthy: False,
ExecutiveOrderFloor: 0,
PublishedDate: String,
ProjectParish: String,
Warnings:
[
String
]
}
]
},
View:
{
RfpDocumentID: 0,
ProjectName: String,
ClientName: String,
BidDueDate: String,
ProjectType: String,
Settings:
{
RfpEstimateID: 0,
StartDate: 0001-01-01,
DeadlineDate: 0001-01-01,
WorkdaysPerWeek: 0,
HoursPerDay: 0,
WeatherPct: 0,
OhpPct: 0,
ContingencyPct: 0,
BondPct: 0,
Holidays:
[
0001-01-01
],
AppliedStartDate: 0001-01-01
},
Jobs:
[
{
Seq: 0,
WorkPackage:
{
HasPackage: False,
Scope: String,
LimitsOfWork: String,
SpecRefs:
[
{
Section: String,
Title: String,
Url: String
}
],
Constraints:
[
String
],
HoldPoints:
[
String
],
Dod:
[
{
Key: String,
Text: String,
Checked: False,
Source: String
}
],
SafetyNote: String,
Provenance: String,
SpecBook: String,
UserEdited: False,
RedraftNote: String
},
ItemNo: String,
Name: String,
Category: String,
SourceRef: String,
Unit: String,
Quantity: 0,
PatternCode: String,
Workdays: 0,
HoursPerDay: 0,
IsNight: False,
WeeklyHours: 0,
OtFraction: 0,
Days: 0,
EffectiveProdPerDay: 0,
CrewPremiumApplied: False,
CrewCost: 0,
FringeCost: 0,
EquipmentCost: 0,
MaterialCost: 0,
SubcontractCost: 0,
Direct: 0,
PricingBasis: String,
PricingRuleId: String,
PricingBandP25: 0,
PricingBandP75: 0,
PricingBandN: 0,
PricingBandLabel: String,
BenchmarkUnitPrice: 0,
ReferencePrice: 0,
ReferenceRangeMin: 0,
ReferenceRangeMax: 0,
ReferenceN: 0,
ReferenceDate: 0001-01-01,
ReferenceBasis: String,
ReferenceUrl: String,
Crew:
[
{
Role: String,
Hours: 0,
StHours: 0,
OtHours: 0,
HasOt: False,
PremiumApplied: False,
NeedsRate: False,
RateKey: String,
Chip: String,
Rrop: 0,
StCost: 0,
OtCost: 0,
Cost: 0,
FringeCost: 0
}
],
Equipment:
[
{
Name: String,
Quantity: 0,
Rate: 0,
NeedsRate: False,
MobCost: 0,
Cost: 0,
IsAvailabilityTracked: False,
IsOwned: False,
AvailabilityLabel: String,
FreedFromProject: String,
AvailableFrom: 0001-01-01,
RateKey: String,
Chip: String,
RentalExplain: String,
UsageDays: 0,
BilledDays: 0
}
],
Materials:
[
{
Name: String,
Quantity: 0,
Unit: String,
Rate: 0,
NeedsRate: False,
Cost: 0,
RateKey: String,
Chip: String
}
],
Subcontracts:
[
{
EstimateSubcontractID: 0,
TaskSeq: 0,
Vendor: String,
Amount: 0,
Scope: String
}
]
}
],
Schedule:
[
{
ItemNo: String,
Description: String,
Unit: String,
Quantity: 0,
UnitPrice: 0,
Extension: 0,
PricingBasis: String,
PricingRuleId: String,
PricingBandP25: 0,
PricingBandP75: 0,
PricingBandN: 0,
PricingBandLabel: String,
BenchmarkDeltaPct: 0,
BenchmarkFlagged: False,
BenchmarkBasis: String,
Provenance: String,
ProvenanceNote: String,
UnpricedResources: 0,
TotalResources: 0
}
],
ScheduleTotal: 0,
Variance:
{
Lines:
[
{
Seq: 0,
ItemNo: String,
Name: String,
Unit: String,
Quantity: 0,
OurUnitPrice: 0,
OurTotal: 0,
BenchmarkUnitPrice: 0,
MarketTotal: 0,
DeltaPct: 0,
RateMin: 0,
RateMax: 0,
SampleSize: 0,
OutsideRange: False,
IsFloor: False,
IsLump: False,
Severity: String,
Adopted: False,
Note: String
}
],
ItemsTotal: 0,
ItemsBenchmarked: 0,
CoverageValuePct: 0,
OursTotal: 0,
MarketTotal: 0,
AggregateDeltaPct: 0,
FlooredCount: 0,
LumpCount: 0,
WatchCount: 0,
OutlierCount: 0,
CriticalCount: 0,
Note: String
},
Indicative:
{
Lines:
[
{
Seq: 0,
ItemNo: String,
Name: String,
Unit: String,
Quantity: 0,
Source: String,
UnitPrice: 0,
LineTotal: 0,
PricePoint: String
}
],
BottomUpCount: 0,
BottomUpTotal: 0,
BenchmarkCount: 0,
BenchmarkTotal: 0,
UncoveredCount: 0,
UncoveredFloorTotal: 0,
IndicativeTotal: 0,
FloorTotal: 0,
Note: String,
Posture: String,
AggressiveTotal: 0,
MarketTotal: 0,
PremiumTotal: 0,
NoDistributionCount: 0
},
Ownership:
{
OwnTotal: 0,
BorrowedTotal: 0,
UnknownFloorTotal: 0,
ScheduleTotal: 0,
OwnCount: 0,
BorrowedCount: 0,
UnknownCount: 0,
OwnPct: 0,
TopExposure:
[
{
ItemNo: String,
Description: String,
Provenance: String,
Extension: 0,
CumulativePct: 0,
Note: String
}
]
},
Summary:
{
Direct: 0,
OhpPct: 0,
OhpAmount: 0,
BondPct: 0,
BondAmount: 0,
ContingencyPct: 0,
ContingencyAmount: 0,
BidTotal: 0,
LoadFactor: 0,
MarginPct: 0
},
Timing:
{
TotalWorkdays: 0,
CalendarDays: 0,
Finish: 0001-01-01,
Feasible: False,
Deadline: 0001-01-01
},
NeedsRateCount: 0,
NeedsRateKeys:
[
String
],
ReviewItems:
[
{
TaskSeq: 0,
TaskName: String,
Reason: String,
Status: String
}
],
NeedsReviewCount: 0,
CanApprove: False,
CanSeePay: False
}
}
}