| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/cad/{AttachmentId}/{VersionNo} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/cad/{AttachmentId} |
export class CadLayout
{
public Name: string;
public IsPaperSpace: boolean;
public constructor(init?: Partial<CadLayout>) { (Object as any).assign(this, init); }
}
export class CadFileInfo
{
public CadFileInfoID: number;
public AttachmentId: string;
public VersionNo: number;
public FileName: string;
public Format: string;
public FormatLabel: string;
public CadVersion: string;
public CadVersionCode: string;
public Units: string;
public DrawingNumber: string;
public Title: string;
public LayoutCount: number;
public Layouts: CadLayout[] = [];
public LayerCount: number;
public EntityCount: number;
public TextChars: number;
public ExtractedText: string;
public Reader: string;
public Status: string;
public ErrorText: string;
public CreatedAt?: string;
public UpdatedAt?: string;
public AgeSeconds: number;
public constructor(init?: Partial<CadFileInfo>) { (Object as any).assign(this, init); }
}
export class CadDerivative
{
public CadDerivativeID: number;
public AttachmentId: string;
public VersionNo: number;
public Urn: string;
public ObjectKey: string;
public Status: string;
public Progress: number;
public StageLabel: string;
public Has2d: boolean;
public Has3d: boolean;
public HasPdf: boolean;
public ThumbKey: string;
public ThumbUrl: string;
public PdfAttachmentId?: string;
public ErrorText: string;
public RequestedBy: string;
public RequestedAt?: string;
public FinishedAt?: string;
public AgeSeconds: number;
public constructor(init?: Partial<CadDerivative>) { (Object as any).assign(this, init); }
}
export class CadCompanion
{
public AttachmentId: string;
public AttachmentName: string;
public CreatedDate?: string;
public FileSizeInKB?: number;
public constructor(init?: Partial<CadCompanion>) { (Object as any).assign(this, init); }
}
export class CadInfoResponse
{
public ResponseStatus: ResponseStatus;
public AttachmentId: string;
public FileName: string;
public Info: CadFileInfo;
public Derivative: CadDerivative;
public Companions: CadCompanion[] = [];
public ApsConnected: boolean;
public CanRender: boolean;
public ViewerScriptUrl: string;
public ViewerStyleUrl: string;
public constructor(init?: Partial<CadInfoResponse>) { (Object as any).assign(this, init); }
}
export class CadInfoRequest
{
public AttachmentId: string;
public VersionNo?: number;
public constructor(init?: Partial<CadInfoRequest>) { (Object as any).assign(this, init); }
}
TypeScript CadInfoRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>