| POST,OPTIONS | /v1/projects/{ProjectID}/bluebeam/import/preview |
|---|
"use strict";
export class BluebeamRow {
/** @param {{RowNo?:number,Subject?:string,PageLabel?:string,PageIndex?:number,Author?:string,Date?:string,Status?:string,Color?:string,Comments?:string,Label?:string,Layer?:string,Space?:string,Length?:number,Area?:number,Count?:number,Volume?:number,Measurement?:string,X?:number,Y?:number,Width?:number,Height?:number,Extras?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RowNo;
/** @type {string} */
Subject;
/** @type {string} */
PageLabel;
/** @type {?number} */
PageIndex;
/** @type {string} */
Author;
/** @type {string} */
Date;
/** @type {string} */
Status;
/** @type {string} */
Color;
/** @type {string} */
Comments;
/** @type {string} */
Label;
/** @type {string} */
Layer;
/** @type {string} */
Space;
/** @type {?number} */
Length;
/** @type {?number} */
Area;
/** @type {?number} */
Count;
/** @type {?number} */
Volume;
/** @type {string} */
Measurement;
/** @type {?number} */
X;
/** @type {?number} */
Y;
/** @type {?number} */
Width;
/** @type {?number} */
Height;
/** @type {{ [index:string]: string; }} */
Extras = {};
}
export class BluebeamMappedRow {
/** @param {{RowNo?:number,Target?:string,Title?:string,Description?:string,Area?:string,Trade?:string,AssignedSub?:string,Priority?:string,Quantity?:number,QuantityKind?:string,Unit?:string,TaskSeq?:number,Reason?:string,Source?:BluebeamRow}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RowNo;
/** @type {string} */
Target;
/** @type {string} */
Title;
/** @type {string} */
Description;
/** @type {string} */
Area;
/** @type {string} */
Trade;
/** @type {string} */
AssignedSub;
/** @type {string} */
Priority;
/** @type {?number} */
Quantity;
/** @type {string} */
QuantityKind;
/** @type {string} */
Unit;
/** @type {?number} */
TaskSeq;
/** @type {string} */
Reason;
/** @type {BluebeamRow} */
Source;
}
export class BluebeamPreviewResponse {
/** @param {{ResponseStatus?:ResponseStatus,FileName?:string,RowCount?:number,Columns?:string[],Rows?:BluebeamMappedRow[],PunchProposed?:number,RfiProposed?:number,QuantityProposed?:number,SkipProposed?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {string} */
FileName;
/** @type {number} */
RowCount;
/** @type {string[]} */
Columns = [];
/** @type {BluebeamMappedRow[]} */
Rows = [];
/** @type {number} */
PunchProposed;
/** @type {number} */
RfiProposed;
/** @type {number} */
QuantityProposed;
/** @type {number} */
SkipProposed;
}
export class BluebeamPreviewRequest {
/** @param {{ProjectID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ProjectID;
}
JavaScript BluebeamPreviewRequest 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/projects/{ProjectID}/bluebeam/import/preview HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BluebeamPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ProjectID>0</ProjectID>
</BluebeamPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BluebeamPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Columns>
<FileName>String</FileName>
<PunchProposed>0</PunchProposed>
<QuantityProposed>0</QuantityProposed>
<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>
<RfiProposed>0</RfiProposed>
<RowCount>0</RowCount>
<Rows>
<BluebeamMappedRow>
<Area>String</Area>
<AssignedSub>String</AssignedSub>
<Description>String</Description>
<Priority>String</Priority>
<Quantity>0</Quantity>
<QuantityKind>String</QuantityKind>
<Reason>String</Reason>
<RowNo>0</RowNo>
<Source>
<Area>0</Area>
<Author>String</Author>
<Color>String</Color>
<Comments>String</Comments>
<Count>0</Count>
<Date>String</Date>
<Extras xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Extras>
<Height>0</Height>
<Label>String</Label>
<Layer>String</Layer>
<Length>0</Length>
<Measurement>String</Measurement>
<PageIndex>0</PageIndex>
<PageLabel>String</PageLabel>
<RowNo>0</RowNo>
<Space>String</Space>
<Status>String</Status>
<Subject>String</Subject>
<Volume>0</Volume>
<Width>0</Width>
<X>0</X>
<Y>0</Y>
</Source>
<Target>String</Target>
<TaskSeq>0</TaskSeq>
<Title>String</Title>
<Trade>String</Trade>
<Unit>String</Unit>
</BluebeamMappedRow>
</Rows>
<SkipProposed>0</SkipProposed>
</BluebeamPreviewResponse>