Trendsic Platform Service

<back to all web services

CadRenderStatusRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/cad/{AttachmentId}/render/status
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 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 CadRenderResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Derivative:CadDerivative = null with get,set

    [<AllowNullLiteral>]
    type CadRenderStatusRequest() = 
        member val AttachmentId:Guid = new Guid() with get,set
        member val VersionNo:Nullable<Int32> = new Nullable<Int32>() with get,set

F# CadRenderStatusRequest 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}/render/status 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
		}
	},
	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
	}
}