Trendsic Platform Service

<back to all web services

CadRenderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/cad/{AttachmentId}/render
"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 CadRenderRequest {
    /** @param {{AttachmentId?:string,VersionNo?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {?number} */
    VersionNo;
}

JavaScript CadRenderRequest DTOs

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

HTTP + XML

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

POST /v1/cad/{AttachmentId}/render HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CadRenderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <VersionNo>0</VersionNo>
</CadRenderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CadRenderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Derivative>
    <AgeSeconds>0</AgeSeconds>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <CadDerivativeID>0</CadDerivativeID>
    <ErrorText>String</ErrorText>
    <FinishedAt>0001-01-01T00:00:00</FinishedAt>
    <Has2d>false</Has2d>
    <Has3d>false</Has3d>
    <HasPdf>false</HasPdf>
    <ObjectKey>String</ObjectKey>
    <PdfAttachmentId>00000000-0000-0000-0000-000000000000</PdfAttachmentId>
    <Progress>0</Progress>
    <RequestedAt>0001-01-01T00:00:00</RequestedAt>
    <RequestedBy>String</RequestedBy>
    <StageLabel>String</StageLabel>
    <Status>String</Status>
    <ThumbKey>String</ThumbKey>
    <ThumbUrl>String</ThumbUrl>
    <Urn>String</Urn>
    <VersionNo>0</VersionNo>
  </Derivative>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CadRenderResponse>