| 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 .other suffix or ?format=other
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: 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"}},"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-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","FinishedAt":"0001-01-01T00:00:00.0000000","AgeSeconds":0},"Companions":[{"AttachmentId":"00000000000000000000000000000000","AttachmentName":"String","CreatedDate":"0001-01-01T00:00:00.0000000","FileSizeInKB":0}],"ApsConnected":false,"CanRender":false,"ViewerScriptUrl":"String","ViewerStyleUrl":"String"}