Trendsic Platform Service

PlanSetUploadRequest

The following routes are available for this service:
POST,OPTIONS	/v1/projects/{ProjectID}/plansets

**PlanSetUploadRequest** Parameters:
Name	Parameter	Data Type	Required
ProjectID	path	int	No
Name	body	string	No
Source	body	string	No
IssuedDate	body	string	No
SupersedesPlanSetUID	body	Guid?	No
ExtractMode	body	string	No
Standalone	body	bool	No

**PlanSetResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
PlanSet	form	PlanSet	No
RemovedSheets	form	List<Sheet>	No

**PlanSet** Parameters:
Name	Parameter	Data Type	Required
PlanSetID	form	int	No
PlanSetUID	form	Guid	No
ProjectID	form	int	No
Name	form	string	No
Source	form	string	No
SourceLabel	form	string	No
IssuedDate	form	DateTime?	No
AttachmentId	form	Guid	No
AttachmentName	form	string	No
FileSizeInKB	form	double?	No
VersionNo	form	int	No
Status	form	string	No
Progress	form	int	No
PageCount	form	int	No
SheetCount	form	int	No
ExtractMode	form	string	No
ErrorText	form	string	No
SupersedesPlanSetID	form	int?	No
SupersedesName	form	string	No
IsCurrent	form	bool	No
CreatedBy	form	string	No
CreatedAt	form	DateTime?	No
ProcessedAt	form	DateTime?	No
AgeSeconds	form	int	No
Sheets	form	List<Sheet>	No
Headline	form	string	No

**Sheet** Parameters:
Name	Parameter	Data Type	Required
SheetID	form	int	No
PlanSetID	form	int	No
PlanSetUID	form	Guid?	No
PlanSetName	form	string	No
ProjectID	form	int	No
PageIndex	form	int	No
AttachmentId	form	Guid	No
VersionNo	form	int	No
SheetNumber	form	string	No
SheetKey	form	string	No
Title	form	string	No
Discipline	form	string	No
Revision	form	string	No
RevisionDate	form	DateTime?	No
WidthPt	form	double	No
HeightPt	form	double	No
ThumbKey	form	string	No
ThumbUrl	form	string	No
ThumbHash	form	string	No
ExtractSource	form	string	No
Confidence	form	double?	No
ChangeKind	form	string	No
SupersedesSheetID	form	int?	No
IsCurrent	form	bool	No
PinCount	form	int	No
UpdatedBy	form	string	No
UpdatedAt	form	DateTime?	No
Pins	form	List<SheetPin>	No

**SheetPin** Parameters:
Name	Parameter	Data Type	Required
SheetPinID	form	int	No
SheetID	form	int	No
EntityType	form	string	No
EntityID	form	int?	No
EntityUID	form	Guid?	No
X	form	double	No
Y	form	double	No
Label	form	string	No
CreatedBy	form	string	No
CreatedAt	form	DateTime?	No
EntityNo	form	string	No
EntityTitle	form	string	No
EntityStatus	form	string	No
InspectionUID	form	Guid?	No
SheetNumber	form	string	No
SheetTitle	form	string	No
PlanSetID	form	int?	No
PlanSetUID	form	Guid?	No
PlanSetName	form	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}/plansets HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	Name: String,
	Source: String,
	IssuedDate: String,
	SupersedesPlanSetUID: 00000000000000000000000000000000,
	ExtractMode: String,
	Standalone: False
}

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
		}
	},
	PlanSet: 
	{
		PlanSetID: 0,
		PlanSetUID: 00000000000000000000000000000000,
		ProjectID: 0,
		Name: String,
		Source: String,
		SourceLabel: String,
		IssuedDate: 0001-01-01,
		AttachmentId: 00000000000000000000000000000000,
		AttachmentName: String,
		FileSizeInKB: 0,
		VersionNo: 0,
		Status: String,
		Progress: 0,
		PageCount: 0,
		SheetCount: 0,
		ExtractMode: String,
		ErrorText: String,
		SupersedesPlanSetID: 0,
		SupersedesName: String,
		IsCurrent: False,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		ProcessedAt: 0001-01-01,
		AgeSeconds: 0,
		Sheets: 
		[
			{
				SheetID: 0,
				PlanSetID: 0,
				PlanSetUID: 00000000000000000000000000000000,
				PlanSetName: String,
				ProjectID: 0,
				PageIndex: 0,
				AttachmentId: 00000000000000000000000000000000,
				VersionNo: 0,
				SheetNumber: String,
				SheetKey: String,
				Title: String,
				Discipline: String,
				Revision: String,
				RevisionDate: 0001-01-01,
				WidthPt: 0,
				HeightPt: 0,
				ThumbKey: String,
				ThumbUrl: String,
				ThumbHash: String,
				ExtractSource: String,
				Confidence: 0,
				ChangeKind: String,
				SupersedesSheetID: 0,
				IsCurrent: False,
				PinCount: 0,
				UpdatedBy: String,
				UpdatedAt: 0001-01-01,
				Pins: 
				[
					{
						SheetPinID: 0,
						SheetID: 0,
						EntityType: String,
						EntityID: 0,
						EntityUID: 00000000000000000000000000000000,
						X: 0,
						Y: 0,
						Label: String,
						CreatedBy: String,
						CreatedAt: 0001-01-01,
						EntityNo: String,
						EntityTitle: String,
						EntityStatus: String,
						InspectionUID: 00000000000000000000000000000000,
						SheetNumber: String,
						SheetTitle: String,
						PlanSetID: 0,
						PlanSetUID: 00000000000000000000000000000000,
						PlanSetName: String
					}
				]
			}
		],
		Headline: String
	},
	RemovedSheets: 
	[
		{
			SheetID: 0,
			PlanSetID: 0,
			PlanSetUID: 00000000000000000000000000000000,
			PlanSetName: String,
			ProjectID: 0,
			PageIndex: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			SheetNumber: String,
			SheetKey: String,
			Title: String,
			Discipline: String,
			Revision: String,
			RevisionDate: 0001-01-01,
			WidthPt: 0,
			HeightPt: 0,
			ThumbKey: String,
			ThumbUrl: String,
			ThumbHash: String,
			ExtractSource: String,
			Confidence: 0,
			ChangeKind: String,
			SupersedesSheetID: 0,
			IsCurrent: False,
			PinCount: 0,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			Pins: 
			[
				{
					SheetPinID: 0,
					SheetID: 0,
					EntityType: String,
					EntityID: 0,
					EntityUID: 00000000000000000000000000000000,
					X: 0,
					Y: 0,
					Label: String,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					EntityNo: String,
					EntityTitle: String,
					EntityStatus: String,
					InspectionUID: 00000000000000000000000000000000,
					SheetNumber: String,
					SheetTitle: String,
					PlanSetID: 0,
					PlanSetUID: 00000000000000000000000000000000,
					PlanSetName: String
				}
			]
		}
	]
}