| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/cad/{AttachmentId}/{VersionNo} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/cad/{AttachmentId} |
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CadLayout() =
member val Name:String = null with get,set
member val IsPaperSpace:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type CadFileInfo() =
member val CadFileInfoID:Int32 = new Int32() with get,set
member val AttachmentId:Guid = new Guid() with get,set
member val VersionNo:Int32 = new Int32() with get,set
member val FileName:String = null with get,set
member val Format:String = null with get,set
member val FormatLabel:String = null with get,set
member val CadVersion:String = null with get,set
member val CadVersionCode:String = null with get,set
member val Units:String = null with get,set
member val DrawingNumber:String = null with get,set
member val Title:String = null with get,set
member val LayoutCount:Int32 = new Int32() with get,set
member val Layouts:ResizeArray<CadLayout> = new ResizeArray<CadLayout>() with get,set
member val LayerCount:Int32 = new Int32() with get,set
member val EntityCount:Int32 = new Int32() with get,set
member val TextChars:Int32 = new Int32() with get,set
member val ExtractedText:String = null with get,set
member val Reader:String = null with get,set
member val Status:String = null with get,set
member val ErrorText:String = null with get,set
member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val AgeSeconds:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type CadDerivative() =
member val CadDerivativeID:Int32 = new Int32() with get,set
member val AttachmentId:Guid = new Guid() with get,set
member val VersionNo:Int32 = new Int32() with get,set
member val Urn:String = null with get,set
member val ObjectKey:String = null with get,set
member val Status:String = null with get,set
member val Progress:Int32 = new Int32() with get,set
member val StageLabel:String = null with get,set
member val Has2d:Boolean = new Boolean() with get,set
member val Has3d:Boolean = new Boolean() with get,set
member val HasPdf:Boolean = new Boolean() with get,set
member val ThumbKey:String = null with get,set
member val ThumbUrl:String = null with get,set
member val PdfAttachmentId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val ErrorText:String = null with get,set
member val RequestedBy:String = null with get,set
member val RequestedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val FinishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val AgeSeconds:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type CadCompanion() =
member val AttachmentId:Guid = new Guid() with get,set
member val AttachmentName:String = null with get,set
member val CreatedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val FileSizeInKB:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type CadInfoResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val AttachmentId:Guid = new Guid() with get,set
member val FileName:String = null with get,set
member val Info:CadFileInfo = null with get,set
member val Derivative:CadDerivative = null with get,set
member val Companions:ResizeArray<CadCompanion> = new ResizeArray<CadCompanion>() with get,set
member val ApsConnected:Boolean = new Boolean() with get,set
member val CanRender:Boolean = new Boolean() with get,set
member val ViewerScriptUrl:String = null with get,set
member val ViewerStyleUrl:String = null with get,set
[<AllowNullLiteral>]
type CadInfoRequest() =
member val AttachmentId:Guid = new Guid() with get,set
member val VersionNo:Nullable<Int32> = new Nullable<Int32>() with get,set
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>