Trendsic Platform Service

<back to all web services

CadRenderStatusRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/cad/{AttachmentId}/render/status
"use strict";
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 CadRenderResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Derivative?:CadDerivative}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CadDerivative} */
    Derivative;
}
export class CadRenderStatusRequest {
    /** @param {{AttachmentId?:string,VersionNo?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {?number} */
    VersionNo;
}

JavaScript CadRenderStatusRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/cad/{AttachmentId}/render/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"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-01T00:00:00.0000000","FinishedAt":"0001-01-01T00:00:00.0000000","AgeSeconds":0}}