Trendsic Platform Service

AttachmentRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,PUT,DELETE,OPTIONS	/v1/Attachment/{AttachmentId}
POST,OPTIONS	/v1/Attachment/{TableName}/{FieldName}/{RecordId}/{NeedsOCR}
POST,OPTIONS	/v1/Attachment/{TableName}/{FieldName}/{RecordId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class AttachmentRequest
{
    open var Attachment:ArrayList<Attachment> = ArrayList<Attachment>()
    open var AttachmentId:UUID? = null
    open var TableName:String? = null
    open var FieldName:String? = null
    open var RecordId:Int? = null
    open var NeedsOCR:Boolean? = null
}

open class Attachment
{
    open var AttachmentId:UUID? = null
    open var TableName:String? = null
    open var FieldName:String? = null
    open var RecordId:Int? = null
    open var AttachmentName:String? = null
    open var MimeType:String? = null
    open var AttachmentData:ByteArray = ByteArray(0)
    open var FileSizeInKB:Double? = null
    open var CreatedDate:Date? = null
    open var CreatedBy:String? = null
    open var NeedsOCR:Boolean? = null
    open var OCRDate:Date? = null
    open var IsSecurities:Boolean? = null
    open var AWSKey:String? = null
    open var PresignedUrl:String? = null
}

open class AttachmentResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Attachment:ArrayList<Attachment> = ArrayList<Attachment>()
}

Kotlin AttachmentRequest 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/Attachment/{TableName}/{FieldName}/{RecordId}/{NeedsOCR} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Attachment: 
	[
		{
			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
		}
	],
	AttachmentId: 00000000000000000000000000000000,
	TableName: String,
	FieldName: String,
	RecordId: 0,
	NeedsOCR: False
}

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
		}
	},
	Attachment: 
	[
		{
			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
		}
	]
}