Trendsic Platform Service

<back to all web services

AttachmentVersionRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/AttachmentVersion/{AttachmentId}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class AttachmentVersionRequest
    {
        public UUID AttachmentId = null;
        public String RevisionLabel = null;
        public String Notes = null;
        
        public UUID getAttachmentId() { return AttachmentId; }
        public AttachmentVersionRequest setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public String getRevisionLabel() { return RevisionLabel; }
        public AttachmentVersionRequest setRevisionLabel(String value) { this.RevisionLabel = value; return this; }
        public String getNotes() { return Notes; }
        public AttachmentVersionRequest setNotes(String value) { this.Notes = value; return this; }
    }

    public static class AttachmentVersionResponse
    {
        public ResponseStatus ResponseStatus = null;
        public UUID AttachmentId = null;
        public ArrayList<AttachmentVersion> Versions = new ArrayList<AttachmentVersion>();
        public Integer CurrentVersionNo = null;
        public Attachment Head = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AttachmentVersionResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public AttachmentVersionResponse setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public ArrayList<AttachmentVersion> getVersions() { return Versions; }
        public AttachmentVersionResponse setVersions(ArrayList<AttachmentVersion> value) { this.Versions = value; return this; }
        public Integer getCurrentVersionNo() { return CurrentVersionNo; }
        public AttachmentVersionResponse setCurrentVersionNo(Integer value) { this.CurrentVersionNo = value; return this; }
        public Attachment getHead() { return Head; }
        public AttachmentVersionResponse setHead(Attachment value) { this.Head = value; return this; }
    }

    public static class AttachmentVersion
    {
        public Integer AttachmentVersionId = null;
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public String AttachmentName = null;
        public String MimeType = null;
        public Double FileSizeInKB = null;
        public String AWSKey = null;
        public String RevisionLabel = null;
        public String Notes = null;
        public Integer RestoredFromVersionNo = null;
        public String UploadedBy = null;
        public Date UploadedAt = null;
        public Boolean IsCurrent = null;
        public String DownloadUrl = null;
        
        public Integer getAttachmentVersionId() { return AttachmentVersionId; }
        public AttachmentVersion setAttachmentVersionId(Integer value) { this.AttachmentVersionId = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public AttachmentVersion setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public AttachmentVersion setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public String getAttachmentName() { return AttachmentName; }
        public AttachmentVersion setAttachmentName(String value) { this.AttachmentName = value; return this; }
        public String getMimeType() { return MimeType; }
        public AttachmentVersion setMimeType(String value) { this.MimeType = value; return this; }
        public Double getFileSizeInKB() { return FileSizeInKB; }
        public AttachmentVersion setFileSizeInKB(Double value) { this.FileSizeInKB = value; return this; }
        public String getAwsKey() { return AWSKey; }
        public AttachmentVersion setAwsKey(String value) { this.AWSKey = value; return this; }
        public String getRevisionLabel() { return RevisionLabel; }
        public AttachmentVersion setRevisionLabel(String value) { this.RevisionLabel = value; return this; }
        public String getNotes() { return Notes; }
        public AttachmentVersion setNotes(String value) { this.Notes = value; return this; }
        public Integer getRestoredFromVersionNo() { return RestoredFromVersionNo; }
        public AttachmentVersion setRestoredFromVersionNo(Integer value) { this.RestoredFromVersionNo = value; return this; }
        public String getUploadedBy() { return UploadedBy; }
        public AttachmentVersion setUploadedBy(String value) { this.UploadedBy = value; return this; }
        public Date getUploadedAt() { return UploadedAt; }
        public AttachmentVersion setUploadedAt(Date value) { this.UploadedAt = value; return this; }
        public Boolean getIsCurrent() { return IsCurrent; }
        public AttachmentVersion setIsCurrent(Boolean value) { this.IsCurrent = value; return this; }
        public String getDownloadUrl() { return DownloadUrl; }
        public AttachmentVersion setDownloadUrl(String value) { this.DownloadUrl = value; return this; }
    }

    public static class Attachment
    {
        public UUID AttachmentId = null;
        public String TableName = null;
        public String FieldName = null;
        public Integer RecordId = null;
        public String AttachmentName = null;
        public String MimeType = null;
        public byte[] AttachmentData = new byte[]{};
        public Double FileSizeInKB = null;
        public Date CreatedDate = null;
        public String CreatedBy = null;
        public Boolean NeedsOCR = null;
        public Date OCRDate = null;
        public Boolean IsSecurities = null;
        public String AWSKey = null;
        public String PresignedUrl = null;
        
        public UUID getAttachmentId() { return AttachmentId; }
        public Attachment setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public String getTableName() { return TableName; }
        public Attachment setTableName(String value) { this.TableName = value; return this; }
        public String getFieldName() { return FieldName; }
        public Attachment setFieldName(String value) { this.FieldName = value; return this; }
        public Integer getRecordId() { return RecordId; }
        public Attachment setRecordId(Integer value) { this.RecordId = value; return this; }
        public String getAttachmentName() { return AttachmentName; }
        public Attachment setAttachmentName(String value) { this.AttachmentName = value; return this; }
        public String getMimeType() { return MimeType; }
        public Attachment setMimeType(String value) { this.MimeType = value; return this; }
        public byte[] getAttachmentData() { return AttachmentData; }
        public Attachment setAttachmentData(byte[] value) { this.AttachmentData = value; return this; }
        public Double getFileSizeInKB() { return FileSizeInKB; }
        public Attachment setFileSizeInKB(Double value) { this.FileSizeInKB = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public Attachment setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public Attachment setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Boolean isNeedsOCR() { return NeedsOCR; }
        public Attachment setNeedsOCR(Boolean value) { this.NeedsOCR = value; return this; }
        public Date getOcrDate() { return OCRDate; }
        public Attachment setOcrDate(Date value) { this.OCRDate = value; return this; }
        public Boolean getIsSecurities() { return IsSecurities; }
        public Attachment setIsSecurities(Boolean value) { this.IsSecurities = value; return this; }
        public String getAwsKey() { return AWSKey; }
        public Attachment setAwsKey(String value) { this.AWSKey = value; return this; }
        public String getPresignedUrl() { return PresignedUrl; }
        public Attachment setPresignedUrl(String value) { this.PresignedUrl = value; return this; }
    }

}

Java AttachmentVersionRequest 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.

POST /v1/AttachmentVersion/{AttachmentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AttachmentId: 00000000000000000000000000000000,
	RevisionLabel: String,
	Notes: String
}
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,
	Versions: 
	[
		{
			AttachmentVersionId: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			AttachmentName: String,
			MimeType: String,
			FileSizeInKB: 0,
			AWSKey: String,
			RevisionLabel: String,
			Notes: String,
			RestoredFromVersionNo: 0,
			UploadedBy: String,
			UploadedAt: 0001-01-01,
			IsCurrent: False,
			DownloadUrl: String
		}
	],
	CurrentVersionNo: 0,
	Head: 
	{
		AttachmentId: 00000000000000000000000000000000,
		TableName: String,
		FieldName: String,
		RecordId: 0,
		AttachmentName: String,
		MimeType: String,
		AttachmentData: AA==,
		FileSizeInKB: 0,
		CreatedDate: 0001-01-01,
		CreatedBy: String,
		NeedsOCR: False,
		OCRDate: 0001-01-01,
		IsSecurities: False,
		AWSKey: String,
		PresignedUrl: String
	}
}