Trendsic Platform Service

<back to all web services

PlanSetListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/plansets
PlanSetListRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
PlanSetListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PlanSetsformList<PlanSet>No
CurrentSheetCountformintNo
NeedsReviewCountformintNo
PlanSet Parameters:
NameParameterData TypeRequiredDescription
PlanSetIDformintNo
PlanSetUIDformGuidNo
ProjectIDformintNo
NameformstringNo
SourceformstringNo
SourceLabelformstringNo
IssuedDateformDateTime?No
AttachmentIdformGuidNo
AttachmentNameformstringNo
FileSizeInKBformdouble?No
VersionNoformintNo
StatusformstringNo
ProgressformintNo
PageCountformintNo
SheetCountformintNo
ExtractModeformstringNo
ErrorTextformstringNo
SupersedesPlanSetIDformint?No
SupersedesNameformstringNo
IsCurrentformboolNo
CreatedByformstringNo
CreatedAtformDateTime?No
ProcessedAtformDateTime?No
AgeSecondsformintNo
SheetsformList<Sheet>No
HeadlineformstringNo
Sheet Parameters:
NameParameterData TypeRequiredDescription
SheetIDformintNo
PlanSetIDformintNo
PlanSetUIDformGuid?No
PlanSetNameformstringNo
ProjectIDformintNo
PageIndexformintNo
AttachmentIdformGuidNo
VersionNoformintNo
SheetNumberformstringNo
SheetKeyformstringNo
TitleformstringNo
DisciplineformstringNo
RevisionformstringNo
RevisionDateformDateTime?No
WidthPtformdoubleNo
HeightPtformdoubleNo
ThumbKeyformstringNo
ThumbUrlformstringNo
ThumbHashformstringNo
ExtractSourceformstringNo
Confidenceformdouble?No
ChangeKindformstringNo
SupersedesSheetIDformint?No
IsCurrentformboolNo
PinCountformintNo
UpdatedByformstringNo
UpdatedAtformDateTime?No
PinsformList<SheetPin>No
SheetPin Parameters:
NameParameterData TypeRequiredDescription
SheetPinIDformintNo
SheetIDformintNo
EntityTypeformstringNo
EntityIDformint?No
EntityUIDformGuid?No
XformdoubleNo
YformdoubleNo
LabelformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
EntityNoformstringNo
EntityTitleformstringNo
EntityStatusformstringNo
InspectionUIDformGuid?No
SheetNumberformstringNo
SheetTitleformstringNo
PlanSetIDformint?No
PlanSetUIDformGuid?No
PlanSetNameformstringNo

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.

GET /v1/projects/{ProjectID}/plansets HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	PlanSets: 
	[
		{
			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
		}
	],
	CurrentSheetCount: 0,
	NeedsReviewCount: 0
}