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
BluebeamCommitRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
FileNamebodystringNo
RowsbodyList<BluebeamMappedRow>No
RfpDocumentUIDbodyGuid?No
BluebeamMappedRow Parameters:
NameParameterData TypeRequiredDescription
RowNoformintNo
TargetformstringNo
TitleformstringNo
DescriptionformstringNo
AreaformstringNo
TradeformstringNo
AssignedSubformstringNo
PriorityformstringNo
Quantityformdouble?No
QuantityKindformstringNo
UnitformstringNo
TaskSeqformint?No
ReasonformstringNo
SourceformBluebeamRowNo
BluebeamRow Parameters:
NameParameterData TypeRequiredDescription
RowNoformintNo
SubjectformstringNo
PageLabelformstringNo
PageIndexformint?No
AuthorformstringNo
DateformstringNo
StatusformstringNo
ColorformstringNo
CommentsformstringNo
LabelformstringNo
LayerformstringNo
SpaceformstringNo
Lengthformdouble?No
Areaformdouble?No
Countformdouble?No
Volumeformdouble?No
MeasurementformstringNo
Xformdouble?No
Yformdouble?No
Widthformdouble?No
Heightformdouble?No
ExtrasformDictionary<string, string>No
BluebeamCommitResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformBluebeamCommitResultNo
QuantitiesCsvformstringNo
QuantitiesWrittenformintNo
BluebeamCommitResult Parameters:
NameParameterData TypeRequiredDescription
PunchCreatedformintNo
RfisCreatedformintNo
SkippedformintNo
CreatedformList<string>No
QuantitiesformList<BluebeamMappedRow>No
ErrorsformList<string>No

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
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
}