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

public class dtos
{

    public static class CadRenderStatusRequest
    {
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        
        public UUID getAttachmentId() { return AttachmentId; }
        public CadRenderStatusRequest setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public CadRenderStatusRequest setVersionNo(Integer value) { this.VersionNo = value; return this; }
    }

    public static class CadRenderResponse
    {
        public ResponseStatus ResponseStatus = null;
        public CadDerivative Derivative = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CadRenderResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public CadDerivative getDerivative() { return Derivative; }
        public CadRenderResponse setDerivative(CadDerivative value) { this.Derivative = value; return this; }
    }

    public static class CadDerivative
    {
        public Integer CadDerivativeID = null;
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public String Urn = null;
        public String ObjectKey = null;
        public String Status = null;
        public Integer Progress = null;
        public String StageLabel = null;
        public Boolean Has2d = null;
        public Boolean Has3d = null;
        public Boolean HasPdf = null;
        public String ThumbKey = null;
        public String ThumbUrl = null;
        public UUID PdfAttachmentId = null;
        public String ErrorText = null;
        public String RequestedBy = null;
        public Date RequestedAt = null;
        public Date FinishedAt = null;
        public Integer AgeSeconds = null;
        
        public Integer getCadDerivativeID() { return CadDerivativeID; }
        public CadDerivative setCadDerivativeID(Integer value) { this.CadDerivativeID = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public CadDerivative setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public CadDerivative setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public String getUrn() { return Urn; }
        public CadDerivative setUrn(String value) { this.Urn = value; return this; }
        public String getObjectKey() { return ObjectKey; }
        public CadDerivative setObjectKey(String value) { this.ObjectKey = value; return this; }
        public String getStatus() { return Status; }
        public CadDerivative setStatus(String value) { this.Status = value; return this; }
        public Integer getProgress() { return Progress; }
        public CadDerivative setProgress(Integer value) { this.Progress = value; return this; }
        public String getStageLabel() { return StageLabel; }
        public CadDerivative setStageLabel(String value) { this.StageLabel = value; return this; }
        public Boolean isHas2d() { return Has2d; }
        public CadDerivative setHas2d(Boolean value) { this.Has2d = value; return this; }
        public Boolean isHas3d() { return Has3d; }
        public CadDerivative setHas3d(Boolean value) { this.Has3d = value; return this; }
        public Boolean isHasPdf() { return HasPdf; }
        public CadDerivative setHasPdf(Boolean value) { this.HasPdf = value; return this; }
        public String getThumbKey() { return ThumbKey; }
        public CadDerivative setThumbKey(String value) { this.ThumbKey = value; return this; }
        public String getThumbUrl() { return ThumbUrl; }
        public CadDerivative setThumbUrl(String value) { this.ThumbUrl = value; return this; }
        public UUID getPdfAttachmentId() { return PdfAttachmentId; }
        public CadDerivative setPdfAttachmentId(UUID value) { this.PdfAttachmentId = value; return this; }
        public String getErrorText() { return ErrorText; }
        public CadDerivative setErrorText(String value) { this.ErrorText = value; return this; }
        public String getRequestedBy() { return RequestedBy; }
        public CadDerivative setRequestedBy(String value) { this.RequestedBy = value; return this; }
        public Date getRequestedAt() { return RequestedAt; }
        public CadDerivative setRequestedAt(Date value) { this.RequestedAt = value; return this; }
        public Date getFinishedAt() { return FinishedAt; }
        public CadDerivative setFinishedAt(Date value) { this.FinishedAt = value; return this; }
        public Integer getAgeSeconds() { return AgeSeconds; }
        public CadDerivative setAgeSeconds(Integer value) { this.AgeSeconds = value; return this; }
    }

}

Java CadRenderStatusRequest DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CadRenderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <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>
</CadRenderResponse>