Trendsic Platform Service

CadInfoRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/cad/{AttachmentId}/{VersionNo}
GET,OPTIONS	/v1/cad/{AttachmentId}

"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 CadInfoRequest {
    /** @param {{AttachmentId?:string,VersionNo?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {?number} */
    VersionNo;
}

JavaScript CadInfoRequest 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.

GET /v1/cad/{AttachmentId}/{VersionNo} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CadInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ApsConnected>false</ApsConnected>
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <CanRender>false</CanRender>
  <Companions>
    <CadCompanion>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FileSizeInKB>0</FileSizeInKB>
    </CadCompanion>
  </Companions>
  <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>
  <FileName>String</FileName>
  <Info>
    <AgeSeconds>0</AgeSeconds>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <CadFileInfoID>0</CadFileInfoID>
    <CadVersion>String</CadVersion>
    <CadVersionCode>String</CadVersionCode>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <DrawingNumber>String</DrawingNumber>
    <EntityCount>0</EntityCount>
    <ErrorText>String</ErrorText>
    <ExtractedText>String</ExtractedText>
    <FileName>String</FileName>
    <Format>String</Format>
    <FormatLabel>String</FormatLabel>
    <LayerCount>0</LayerCount>
    <LayoutCount>0</LayoutCount>
    <Layouts>
      <CadLayout>
        <IsPaperSpace>false</IsPaperSpace>
        <Name>String</Name>
      </CadLayout>
    </Layouts>
    <Reader>String</Reader>
    <Status>String</Status>
    <TextChars>0</TextChars>
    <Title>String</Title>
    <Units>String</Units>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <VersionNo>0</VersionNo>
  </Info>
  <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>
  <ViewerScriptUrl>String</ViewerScriptUrl>
  <ViewerStyleUrl>String</ViewerStyleUrl>
</CadInfoResponse>