| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Estimate/Jobs/{TaskSeq}/assembly |
|---|
"use strict";
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 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 EstimateCrewLineResult {
/** @param {{Role?:string,Hours?:number,StHours?:number,OtHours?:number,Rrop?:number,StCost?:number,OtCost?:number,Cost?:number,FringeCost?:number,PremiumApplied?:boolean,HasOt?:boolean,NeedsRate?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Role;
/** @type {number} */
Hours;
/** @type {number} */
StHours;
/** @type {number} */
OtHours;
/** @type {number} */
Rrop;
/** @type {number} */
StCost;
/** @type {number} */
OtCost;
/** @type {number} */
Cost;
/** @type {number} */
FringeCost;
/** @type {boolean} */
PremiumApplied;
/** @type {boolean} */
HasOt;
/** @type {boolean} */
NeedsRate;
}
export class EstimateEquipmentLineResult {
/** @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,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} */
RentalExplain;
/** @type {number} */
UsageDays;
/** @type {number} */
BilledDays;
}
export class EstimateMaterialLineResult {
/** @param {{Name?:string,Quantity?:number,Unit?:string,Rate?:number,NeedsRate?:boolean,Cost?:number,RateKey?: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;
}
export class EstimateSubcontractLine {
/** @param {{Vendor?:string,Amount?:number,Scope?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Vendor;
/** @type {number} */
Amount;
/** @type {string} */
Scope;
}
export class EstimateJobResult {
/** @param {{Seq?:number,DependsOn?:number[],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,WorkPackage?:WorkPackageView,Crew?:EstimateCrewLineResult[],Equipment?:EstimateEquipmentLineResult[],Materials?:EstimateMaterialLineResult[],Subcontracts?:EstimateSubcontractLine[],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,BenchmarkRateMin?:number,BenchmarkRateMax?:number,BenchmarkSampleSize?:number,BenchmarkP25?:number,BenchmarkP75?:number,BenchmarkBasis?:string,UnitPriceOverride?:number,OverrideBasis?:string,ReferencePrice?:number,ReferenceRangeMin?:number,ReferenceRangeMax?:number,ReferenceN?:number,ReferenceDate?:string,ReferenceBasis?:string,ReferenceUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Seq;
/** @type {number[]} */
DependsOn = [];
/** @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 {WorkPackageView} */
WorkPackage;
/** @type {EstimateCrewLineResult[]} */
Crew = [];
/** @type {EstimateEquipmentLineResult[]} */
Equipment = [];
/** @type {EstimateMaterialLineResult[]} */
Materials = [];
/** @type {EstimateSubcontractLine[]} */
Subcontracts = [];
/** @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} */
BenchmarkRateMin;
/** @type {?number} */
BenchmarkRateMax;
/** @type {?number} */
BenchmarkSampleSize;
/** @type {?number} */
BenchmarkP25;
/** @type {?number} */
BenchmarkP75;
/** @type {string} */
BenchmarkBasis;
/** @type {?number} */
UnitPriceOverride;
/** @type {string} */
OverrideBasis;
/** @type {?number} */
ReferencePrice;
/** @type {?number} */
ReferenceRangeMin;
/** @type {?number} */
ReferenceRangeMax;
/** @type {?number} */
ReferenceN;
/** @type {?string} */
ReferenceDate;
/** @type {string} */
ReferenceBasis;
/** @type {string} */
ReferenceUrl;
}
export class ApplyAssemblyResponse {
/** @param {{ResponseStatus?:ResponseStatus,TaskSeq?:number,TemplateUID?:string,TemplateName?:string,Quantity?:number,Unit?:string,Resourcing?:TaskResourcing,Job?:EstimateJobResult,Headline?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {number} */
TaskSeq;
/** @type {?string} */
TemplateUID;
/** @type {string} */
TemplateName;
/** @type {number} */
Quantity;
/** @type {string} */
Unit;
/** @type {TaskResourcing} */
Resourcing;
/** @type {EstimateJobResult} */
Job;
/** @type {string} */
Headline;
}
export class ApplyAssemblyRequest {
/** @param {{RfpDocumentUID?:string,TaskSeq?:number,TemplateUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RfpDocumentUID;
/** @type {number} */
TaskSeq;
/** @type {string} */
TemplateUID;
}
JavaScript ApplyAssemblyRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Rfp/{RfpDocumentUID}/Estimate/Jobs/{TaskSeq}/assembly HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ApplyAssemblyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<RfpDocumentUID>00000000-0000-0000-0000-000000000000</RfpDocumentUID>
<TaskSeq>0</TaskSeq>
<TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
</ApplyAssemblyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ApplyAssemblyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Headline>String</Headline>
<Job>
<BenchmarkBasis>String</BenchmarkBasis>
<BenchmarkP25>0</BenchmarkP25>
<BenchmarkP75>0</BenchmarkP75>
<BenchmarkRateMax>0</BenchmarkRateMax>
<BenchmarkRateMin>0</BenchmarkRateMin>
<BenchmarkSampleSize>0</BenchmarkSampleSize>
<BenchmarkUnitPrice>0</BenchmarkUnitPrice>
<Category>String</Category>
<Crew>
<EstimateCrewLineResult>
<Cost>0</Cost>
<FringeCost>0</FringeCost>
<HasOt>false</HasOt>
<Hours>0</Hours>
<NeedsRate>false</NeedsRate>
<OtCost>0</OtCost>
<OtHours>0</OtHours>
<PremiumApplied>false</PremiumApplied>
<Role>String</Role>
<Rrop>0</Rrop>
<StCost>0</StCost>
<StHours>0</StHours>
</EstimateCrewLineResult>
</Crew>
<CrewCost>0</CrewCost>
<CrewPremiumApplied>false</CrewPremiumApplied>
<Days>0</Days>
<DependsOn xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>0</d3p1:int>
</DependsOn>
<Direct>0</Direct>
<EffectiveProdPerDay>0</EffectiveProdPerDay>
<Equipment>
<EstimateEquipmentLineResult>
<AvailabilityLabel>String</AvailabilityLabel>
<AvailableFrom>0001-01-01T00:00:00</AvailableFrom>
<BilledDays>0</BilledDays>
<Cost>0</Cost>
<FreedFromProject>String</FreedFromProject>
<IsAvailabilityTracked>false</IsAvailabilityTracked>
<IsOwned>false</IsOwned>
<MobCost>0</MobCost>
<Name>String</Name>
<NeedsRate>false</NeedsRate>
<Quantity>0</Quantity>
<Rate>0</Rate>
<RateKey>String</RateKey>
<RentalExplain>String</RentalExplain>
<UsageDays>0</UsageDays>
</EstimateEquipmentLineResult>
</Equipment>
<EquipmentCost>0</EquipmentCost>
<FringeCost>0</FringeCost>
<HoursPerDay>0</HoursPerDay>
<IsNight>false</IsNight>
<ItemNo>String</ItemNo>
<MaterialCost>0</MaterialCost>
<Materials>
<EstimateMaterialLineResult>
<Cost>0</Cost>
<Name>String</Name>
<NeedsRate>false</NeedsRate>
<Quantity>0</Quantity>
<Rate>0</Rate>
<RateKey>String</RateKey>
<Unit>String</Unit>
</EstimateMaterialLineResult>
</Materials>
<Name>String</Name>
<OtFraction>0</OtFraction>
<OverrideBasis>String</OverrideBasis>
<PatternCode>String</PatternCode>
<PricingBandLabel>String</PricingBandLabel>
<PricingBandN>0</PricingBandN>
<PricingBandP25>0</PricingBandP25>
<PricingBandP75>0</PricingBandP75>
<PricingBasis>String</PricingBasis>
<PricingRuleId>String</PricingRuleId>
<Quantity>0</Quantity>
<ReferenceBasis>String</ReferenceBasis>
<ReferenceDate>0001-01-01T00:00:00</ReferenceDate>
<ReferenceN>0</ReferenceN>
<ReferencePrice>0</ReferencePrice>
<ReferenceRangeMax>0</ReferenceRangeMax>
<ReferenceRangeMin>0</ReferenceRangeMin>
<ReferenceUrl>String</ReferenceUrl>
<Seq>0</Seq>
<SourceRef>String</SourceRef>
<SubcontractCost>0</SubcontractCost>
<Subcontracts>
<EstimateSubcontractLine>
<Amount>0</Amount>
<Scope>String</Scope>
<Vendor>String</Vendor>
</EstimateSubcontractLine>
</Subcontracts>
<Unit>String</Unit>
<UnitPriceOverride>0</UnitPriceOverride>
<WeeklyHours>0</WeeklyHours>
<WorkPackage>
<Constraints xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Constraints>
<Dod>
<RfpWorkPackageService.DodItemView>
<Checked>false</Checked>
<Key>String</Key>
<Source>String</Source>
<Text>String</Text>
</RfpWorkPackageService.DodItemView>
</Dod>
<HasPackage>false</HasPackage>
<HoldPoints xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</HoldPoints>
<LimitsOfWork>String</LimitsOfWork>
<Provenance>String</Provenance>
<RedraftNote>String</RedraftNote>
<SafetyNote>String</SafetyNote>
<Scope>String</Scope>
<SpecBook>String</SpecBook>
<SpecRefs>
<RfpWorkPackageService.SpecRefView>
<Section>String</Section>
<Title>String</Title>
<Url>String</Url>
</RfpWorkPackageService.SpecRefView>
</SpecRefs>
<UserEdited>false</UserEdited>
</WorkPackage>
<Workdays>0</Workdays>
</Job>
<Quantity>0</Quantity>
<Resourcing>
<Equipment>
<ResourcedEquipment>
<DurationDays>0</DurationDays>
<EquipmentID>0</EquipmentID>
<EquipmentName>String</EquipmentName>
<FixedDays>0</FixedDays>
<IsInCatalog>false</IsInCatalog>
<MakeModel>String</MakeModel>
<Notes>String</Notes>
<Quantity>0</Quantity>
<SourceReference>String</SourceReference>
<SuggestedEquipmentID>0</SuggestedEquipmentID>
<SuggestedEquipmentName>String</SuggestedEquipmentName>
<Utilization>0</Utilization>
</ResourcedEquipment>
</Equipment>
<FixedDays>0</FixedDays>
<Materials>
<ResourcedMaterial>
<IsInCatalog>false</IsInCatalog>
<MakeModel>String</MakeModel>
<MaterialID>0</MaterialID>
<MaterialName>String</MaterialName>
<Notes>String</Notes>
<Quantity>0</Quantity>
<QuantityPerUnit>0</QuantityPerUnit>
<SourceReference>String</SourceReference>
<SuggestedMaterialID>0</SuggestedMaterialID>
<SuggestedMaterialName>String</SuggestedMaterialName>
<Unit>String</Unit>
</ResourcedMaterial>
</Materials>
<Positions>
<ResourcedPosition>
<ContactID>0</ContactID>
<CrewSize>0</CrewSize>
<FixedDays>0</FixedDays>
<Headcount>0</Headcount>
<Hours>0</Hours>
<IsInCatalog>false</IsInCatalog>
<Notes>String</Notes>
<PositionTag>String</PositionTag>
<SourceReference>String</SourceReference>
<Utilization>0</Utilization>
</ResourcedPosition>
</Positions>
<ProductionRatePerDay>0</ProductionRatePerDay>
<ResourcedForQuantity>0</ResourcedForQuantity>
</Resourcing>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<TaskSeq>0</TaskSeq>
<TemplateName>String</TemplateName>
<TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
<Unit>String</Unit>
</ApplyAssemblyResponse>