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

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 CadRenderResponse
{
    public ResponseStatus: ResponseStatus;
    public Derivative: CadDerivative;

    public constructor(init?: Partial<CadRenderResponse>) { (Object as any).assign(this, init); }
}

export class CadRenderStatusRequest
{
    public AttachmentId: string;
    public VersionNo?: number;

    public constructor(init?: Partial<CadRenderStatusRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}