| GET,OPTIONS | /v1/projects/{ProjectID}/plansets |
|---|
"use strict";
export class SheetPin {
/** @param {{SheetPinID?:number,SheetID?:number,EntityType?:string,EntityID?:number,EntityUID?:string,X?:number,Y?:number,Label?:string,CreatedBy?:string,CreatedAt?:string,EntityNo?:string,EntityTitle?:string,EntityStatus?:string,InspectionUID?:string,SheetNumber?:string,SheetTitle?:string,PlanSetID?:number,PlanSetUID?:string,PlanSetName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SheetPinID;
/** @type {number} */
SheetID;
/** @type {string} */
EntityType;
/** @type {?number} */
EntityID;
/** @type {?string} */
EntityUID;
/** @type {number} */
X;
/** @type {number} */
Y;
/** @type {string} */
Label;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {string} */
EntityNo;
/** @type {string} */
EntityTitle;
/** @type {string} */
EntityStatus;
/** @type {?string} */
InspectionUID;
/** @type {string} */
SheetNumber;
/** @type {string} */
SheetTitle;
/** @type {?number} */
PlanSetID;
/** @type {?string} */
PlanSetUID;
/** @type {string} */
PlanSetName;
}
export class Sheet {
/** @param {{SheetID?:number,PlanSetID?:number,PlanSetUID?:string,PlanSetName?:string,ProjectID?:number,PageIndex?:number,AttachmentId?:string,VersionNo?:number,SheetNumber?:string,SheetKey?:string,Title?:string,Discipline?:string,Revision?:string,RevisionDate?:string,WidthPt?:number,HeightPt?:number,ThumbKey?:string,ThumbUrl?:string,ThumbHash?:string,ExtractSource?:string,Confidence?:number,ChangeKind?:string,SupersedesSheetID?:number,IsCurrent?:boolean,PinCount?:number,UpdatedBy?:string,UpdatedAt?:string,Pins?:SheetPin[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SheetID;
/** @type {number} */
PlanSetID;
/** @type {?string} */
PlanSetUID;
/** @type {string} */
PlanSetName;
/** @type {number} */
ProjectID;
/** @type {number} */
PageIndex;
/** @type {string} */
AttachmentId;
/** @type {number} */
VersionNo;
/** @type {string} */
SheetNumber;
/** @type {string} */
SheetKey;
/** @type {string} */
Title;
/** @type {string} */
Discipline;
/** @type {string} */
Revision;
/** @type {?string} */
RevisionDate;
/** @type {number} */
WidthPt;
/** @type {number} */
HeightPt;
/** @type {string} */
ThumbKey;
/** @type {string} */
ThumbUrl;
/** @type {string} */
ThumbHash;
/** @type {string} */
ExtractSource;
/** @type {?number} */
Confidence;
/** @type {string} */
ChangeKind;
/** @type {?number} */
SupersedesSheetID;
/** @type {boolean} */
IsCurrent;
/** @type {number} */
PinCount;
/** @type {string} */
UpdatedBy;
/** @type {?string} */
UpdatedAt;
/** @type {SheetPin[]} */
Pins = [];
}
export class PlanSet {
/** @param {{PlanSetID?:number,PlanSetUID?:string,ProjectID?:number,Name?:string,Source?:string,SourceLabel?:string,IssuedDate?:string,AttachmentId?:string,AttachmentName?:string,FileSizeInKB?:number,VersionNo?:number,Status?:string,Progress?:number,PageCount?:number,SheetCount?:number,ExtractMode?:string,ErrorText?:string,SupersedesPlanSetID?:number,SupersedesName?:string,IsCurrent?:boolean,CreatedBy?:string,CreatedAt?:string,ProcessedAt?:string,AgeSeconds?:number,Sheets?:Sheet[],Headline?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
PlanSetID;
/** @type {string} */
PlanSetUID;
/** @type {number} */
ProjectID;
/** @type {string} */
Name;
/** @type {string} */
Source;
/** @type {string} */
SourceLabel;
/** @type {?string} */
IssuedDate;
/** @type {string} */
AttachmentId;
/** @type {string} */
AttachmentName;
/** @type {?number} */
FileSizeInKB;
/** @type {number} */
VersionNo;
/** @type {string} */
Status;
/** @type {number} */
Progress;
/** @type {number} */
PageCount;
/** @type {number} */
SheetCount;
/** @type {string} */
ExtractMode;
/** @type {string} */
ErrorText;
/** @type {?number} */
SupersedesPlanSetID;
/** @type {string} */
SupersedesName;
/** @type {boolean} */
IsCurrent;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
ProcessedAt;
/** @type {number} */
AgeSeconds;
/** @type {Sheet[]} */
Sheets = [];
/** @type {string} */
Headline;
}
export class PlanSetListResponse {
/** @param {{ResponseStatus?:ResponseStatus,PlanSets?:PlanSet[],CurrentSheetCount?:number,NeedsReviewCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {PlanSet[]} */
PlanSets = [];
/** @type {number} */
CurrentSheetCount;
/** @type {number} */
NeedsReviewCount;
}
export class PlanSetListRequest {
/** @param {{ProjectID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ProjectID;
}
JavaScript PlanSetListRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}