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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CadInfoRequest
{
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
}

open class CadInfoResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var AttachmentId:UUID? = null
    open var FileName:String? = null
    open var Info:CadFileInfo? = null
    open var Derivative:CadDerivative? = null
    open var Companions:ArrayList<CadCompanion> = ArrayList<CadCompanion>()
    open var ApsConnected:Boolean? = null
    open var CanRender:Boolean? = null
    open var ViewerScriptUrl:String? = null
    open var ViewerStyleUrl:String? = null
}

open class CadFileInfo
{
    open var CadFileInfoID:Int? = null
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var FileName:String? = null
    open var Format:String? = null
    open var FormatLabel:String? = null
    open var CadVersion:String? = null
    open var CadVersionCode:String? = null
    open var Units:String? = null
    open var DrawingNumber:String? = null
    open var Title:String? = null
    open var LayoutCount:Int? = null
    open var Layouts:ArrayList<CadLayout> = ArrayList<CadLayout>()
    open var LayerCount:Int? = null
    open var EntityCount:Int? = null
    open var TextChars:Int? = null
    open var ExtractedText:String? = null
    open var Reader:String? = null
    open var Status:String? = null
    open var ErrorText:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
    open var AgeSeconds:Int? = null
}

open class CadLayout
{
    open var Name:String? = null
    open var IsPaperSpace:Boolean? = null
}

open class CadDerivative
{
    open var CadDerivativeID:Int? = null
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var Urn:String? = null
    open var ObjectKey:String? = null
    open var Status:String? = null
    open var Progress:Int? = null
    open var StageLabel:String? = null
    open var Has2d:Boolean? = null
    open var Has3d:Boolean? = null
    open var HasPdf:Boolean? = null
    open var ThumbKey:String? = null
    open var ThumbUrl:String? = null
    open var PdfAttachmentId:UUID? = null
    open var ErrorText:String? = null
    open var RequestedBy:String? = null
    open var RequestedAt:Date? = null
    open var FinishedAt:Date? = null
    open var AgeSeconds:Int? = null
}

open class CadCompanion
{
    open var AttachmentId:UUID? = null
    open var AttachmentName:String? = null
    open var CreatedDate:Date? = null
    open var FileSizeInKB:Double? = null
}

Kotlin CadInfoRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		UpdatedAt: 0001-01-01,
		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-01,
		FinishedAt: 0001-01-01,
		AgeSeconds: 0
	},
	Companions: 
	[
		{
			AttachmentId: 00000000000000000000000000000000,
			AttachmentName: String,
			CreatedDate: 0001-01-01,
			FileSizeInKB: 0
		}
	],
	ApsConnected: False,
	CanRender: False,
	ViewerScriptUrl: String,
	ViewerStyleUrl: String
}