Trendsic Platform Service

<back to all web services

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}
CadInfoRequest Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdpathGuidNo
VersionNopathint?No
CadInfoResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AttachmentIdformGuidNo
FileNameformstringNo
InfoformCadFileInfoNo
DerivativeformCadDerivativeNo
CompanionsformList<CadCompanion>No
ApsConnectedformboolNo
CanRenderformboolNo
ViewerScriptUrlformstringNo
ViewerStyleUrlformstringNo
CadFileInfo Parameters:
NameParameterData TypeRequiredDescription
CadFileInfoIDformintNo
AttachmentIdformGuidNo
VersionNoformintNo
FileNameformstringNo
FormatformstringNo
FormatLabelformstringNo
CadVersionformstringNo
CadVersionCodeformstringNo
UnitsformstringNo
DrawingNumberformstringNo
TitleformstringNo
LayoutCountformintNo
LayoutsformList<CadLayout>No
LayerCountformintNo
EntityCountformintNo
TextCharsformintNo
ExtractedTextformstringNo
ReaderformstringNo
StatusformstringNo
ErrorTextformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
AgeSecondsformintNo
CadLayout Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IsPaperSpaceformboolNo
CadDerivative Parameters:
NameParameterData TypeRequiredDescription
CadDerivativeIDformintNo
AttachmentIdformGuidNo
VersionNoformintNo
UrnformstringNo
ObjectKeyformstringNo
StatusformstringNo
ProgressformintNo
StageLabelformstringNo
Has2dformboolNo
Has3dformboolNo
HasPdfformboolNo
ThumbKeyformstringNo
ThumbUrlformstringNo
PdfAttachmentIdformGuid?No
ErrorTextformstringNo
RequestedByformstringNo
RequestedAtformDateTime?No
FinishedAtformDateTime?No
AgeSecondsformintNo
CadCompanion Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdformGuidNo
AttachmentNameformstringNo
CreatedDateformDateTime?No
FileSizeInKBformdouble?No

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}