Trendsic Platform Service

<back to all web services

BluebeamCommitRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/bluebeam/import/commit

export class BluebeamRow
{
    public RowNo: number;
    public Subject: string;
    public PageLabel: string;
    public PageIndex?: number;
    public Author: string;
    public Date: string;
    public Status: string;
    public Color: string;
    public Comments: string;
    public Label: string;
    public Layer: string;
    public Space: string;
    public Length?: number;
    public Area?: number;
    public Count?: number;
    public Volume?: number;
    public Measurement: string;
    public X?: number;
    public Y?: number;
    public Width?: number;
    public Height?: number;
    public Extras: { [index:string]: string; } = {};

    public constructor(init?: Partial<BluebeamRow>) { (Object as any).assign(this, init); }
}

export class BluebeamMappedRow
{
    public RowNo: number;
    public Target: string;
    public Title: string;
    public Description: string;
    public Area: string;
    public Trade: string;
    public AssignedSub: string;
    public Priority: string;
    public Quantity?: number;
    public QuantityKind: string;
    public Unit: string;
    public TaskSeq?: number;
    public Reason: string;
    public Source: BluebeamRow;

    public constructor(init?: Partial<BluebeamMappedRow>) { (Object as any).assign(this, init); }
}

export class BluebeamCommitResult
{
    public PunchCreated: number;
    public RfisCreated: number;
    public Skipped: number;
    public Created: string[] = [];
    public Quantities: BluebeamMappedRow[] = [];
    public Errors: string[] = [];

    public constructor(init?: Partial<BluebeamCommitResult>) { (Object as any).assign(this, init); }
}

export class BluebeamCommitResponse
{
    public ResponseStatus: ResponseStatus;
    public Result: BluebeamCommitResult;
    public QuantitiesCsv: string;
    public QuantitiesWritten: number;

    public constructor(init?: Partial<BluebeamCommitResponse>) { (Object as any).assign(this, init); }
}

export class BluebeamCommitRequest
{
    public ProjectID: number;
    public FileName: string;
    public Rows: BluebeamMappedRow[] = [];
    public RfpDocumentUID?: string;

    public constructor(init?: Partial<BluebeamCommitRequest>) { (Object as any).assign(this, init); }
}

TypeScript BluebeamCommitRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/projects/{ProjectID}/bluebeam/import/commit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ProjectID":0,"FileName":"String","Rows":[{"RowNo":0,"Target":"String","Title":"String","Description":"String","Area":"String","Trade":"String","AssignedSub":"String","Priority":"String","Quantity":0,"QuantityKind":"String","Unit":"String","TaskSeq":0,"Reason":"String","Source":{"RowNo":0,"Subject":"String","PageLabel":"String","PageIndex":0,"Author":"String","Date":"String","Status":"String","Color":"String","Comments":"String","Label":"String","Layer":"String","Space":"String","Length":0,"Area":0,"Count":0,"Volume":0,"Measurement":"String","X":0,"Y":0,"Width":0,"Height":0,"Extras":{"String":"String"}}}],"RfpDocumentUID":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Result":{"PunchCreated":0,"RfisCreated":0,"Skipped":0,"Created":["String"],"Quantities":[{"RowNo":0,"Target":"String","Title":"String","Description":"String","Area":"String","Trade":"String","AssignedSub":"String","Priority":"String","Quantity":0,"QuantityKind":"String","Unit":"String","TaskSeq":0,"Reason":"String","Source":{"RowNo":0,"Subject":"String","PageLabel":"String","PageIndex":0,"Author":"String","Date":"String","Status":"String","Color":"String","Comments":"String","Label":"String","Layer":"String","Space":"String","Length":0,"Area":0,"Count":0,"Volume":0,"Measurement":"String","X":0,"Y":0,"Width":0,"Height":0,"Extras":{"String":"String"}}}],"Errors":["String"]},"QuantitiesCsv":"String","QuantitiesWritten":0}