| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/cad/{AttachmentId}/reprocess |
|---|
"use strict";
export class CadLayout {
/** @param {{Name?:string,IsPaperSpace?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {boolean} */
IsPaperSpace;
}
export class CadFileInfo {
/** @param {{CadFileInfoID?:number,AttachmentId?:string,VersionNo?:number,FileName?:string,Format?:string,FormatLabel?:string,CadVersion?:string,CadVersionCode?:string,Units?:string,DrawingNumber?:string,Title?:string,LayoutCount?:number,Layouts?:CadLayout[],LayerCount?:number,EntityCount?:number,TextChars?:number,ExtractedText?:string,Reader?:string,Status?:string,ErrorText?:string,CreatedAt?:string,UpdatedAt?:string,AgeSeconds?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CadFileInfoID;
/** @type {string} */
AttachmentId;
/** @type {number} */
VersionNo;
/** @type {string} */
FileName;
/** @type {string} */
Format;
/** @type {string} */
FormatLabel;
/** @type {string} */
CadVersion;
/** @type {string} */
CadVersionCode;
/** @type {string} */
Units;
/** @type {string} */
DrawingNumber;
/** @type {string} */
Title;
/** @type {number} */
LayoutCount;
/** @type {CadLayout[]} */
Layouts = [];
/** @type {number} */
LayerCount;
/** @type {number} */
EntityCount;
/** @type {number} */
TextChars;
/** @type {string} */
ExtractedText;
/** @type {string} */
Reader;
/** @type {string} */
Status;
/** @type {string} */
ErrorText;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
UpdatedAt;
/** @type {number} */
AgeSeconds;
}
export class CadDerivative {
/** @param {{CadDerivativeID?:number,AttachmentId?:string,VersionNo?:number,Urn?:string,ObjectKey?:string,Status?:string,Progress?:number,StageLabel?:string,Has2d?:boolean,Has3d?:boolean,HasPdf?:boolean,ThumbKey?:string,ThumbUrl?:string,PdfAttachmentId?:string,ErrorText?:string,RequestedBy?:string,RequestedAt?:string,FinishedAt?:string,AgeSeconds?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CadDerivativeID;
/** @type {string} */
AttachmentId;
/** @type {number} */
VersionNo;
/** @type {string} */
Urn;
/** @type {string} */
ObjectKey;
/** @type {string} */
Status;
/** @type {number} */
Progress;
/** @type {string} */
StageLabel;
/** @type {boolean} */
Has2d;
/** @type {boolean} */
Has3d;
/** @type {boolean} */
HasPdf;
/** @type {string} */
ThumbKey;
/** @type {string} */
ThumbUrl;
/** @type {?string} */
PdfAttachmentId;
/** @type {string} */
ErrorText;
/** @type {string} */
RequestedBy;
/** @type {?string} */
RequestedAt;
/** @type {?string} */
FinishedAt;
/** @type {number} */
AgeSeconds;
}
export class CadCompanion {
/** @param {{AttachmentId?:string,AttachmentName?:string,CreatedDate?:string,FileSizeInKB?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AttachmentId;
/** @type {string} */
AttachmentName;
/** @type {?string} */
CreatedDate;
/** @type {?number} */
FileSizeInKB;
}
export class CadInfoResponse {
/** @param {{ResponseStatus?:ResponseStatus,AttachmentId?:string,FileName?:string,Info?:CadFileInfo,Derivative?:CadDerivative,Companions?:CadCompanion[],ApsConnected?:boolean,CanRender?:boolean,ViewerScriptUrl?:string,ViewerStyleUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {string} */
AttachmentId;
/** @type {string} */
FileName;
/** @type {CadFileInfo} */
Info;
/** @type {CadDerivative} */
Derivative;
/** @type {CadCompanion[]} */
Companions = [];
/** @type {boolean} */
ApsConnected;
/** @type {boolean} */
CanRender;
/** @type {string} */
ViewerScriptUrl;
/** @type {string} */
ViewerStyleUrl;
}
export class CadReprocessRequest {
/** @param {{AttachmentId?:string,VersionNo?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AttachmentId;
/** @type {?number} */
VersionNo;
}
JavaScript CadReprocessRequest 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.
POST /v1/cad/{AttachmentId}/reprocess HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AttachmentId: 00000000000000000000000000000000,
VersionNo: 0
}
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
}
},
AttachmentId: 00000000000000000000000000000000,
FileName: String,
Info:
{
CadFileInfoID: 0,
AttachmentId: 00000000000000000000000000000000,
VersionNo: 0,
FileName: String,
Format: String,
FormatLabel: String,
CadVersion: String,
CadVersionCode: String,
Units: String,
DrawingNumber: String,
Title: String,
LayoutCount: 0,
Layouts:
[
{
Name: String,
IsPaperSpace: False
}
],
LayerCount: 0,
EntityCount: 0,
TextChars: 0,
ExtractedText: String,
Reader: String,
Status: String,
ErrorText: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01,
AgeSeconds: 0
},
Derivative:
{
CadDerivativeID: 0,
AttachmentId: 00000000000000000000000000000000,
VersionNo: 0,
Urn: String,
ObjectKey: String,
Status: String,
Progress: 0,
StageLabel: String,
Has2d: False,
Has3d: False,
HasPdf: False,
ThumbKey: String,
ThumbUrl: String,
PdfAttachmentId: 00000000000000000000000000000000,
ErrorText: String,
RequestedBy: String,
RequestedAt: 0001-01-01,
FinishedAt: 0001-01-01,
AgeSeconds: 0
},
Companions:
[
{
AttachmentId: 00000000000000000000000000000000,
AttachmentName: String,
CreatedDate: 0001-01-01,
FileSizeInKB: 0
}
],
ApsConnected: False,
CanRender: False,
ViewerScriptUrl: String,
ViewerStyleUrl: String
}