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}

"use strict";
export class Attachment {
    /** @param {{AttachmentId?:string,TableName?:string,FieldName?:string,RecordId?:number,AttachmentName?:string,MimeType?:string,AttachmentData?:string,FileSizeInKB?:number,CreatedDate?:string,CreatedBy?:string,NeedsOCR?:boolean,OCRDate?:string,IsSecurities?:boolean,AWSKey?:string,PresignedUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    TableName;
    /** @type {string} */
    FieldName;
    /** @type {number} */
    RecordId;
    /** @type {string} */
    AttachmentName;
    /** @type {string} */
    MimeType;
    /** @type {string} */
    AttachmentData = [];
    /** @type {number} */
    FileSizeInKB;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    CreatedBy;
    /** @type {boolean} */
    NeedsOCR;
    /** @type {string} */
    OCRDate;
    /** @type {boolean} */
    IsSecurities;
    /** @type {string} */
    AWSKey;
    /** @type {string} */
    PresignedUrl;
}
export class AttachmentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Attachment?:Attachment[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Attachment[]} */
    Attachment = [];
}
export class AttachmentRequest {
    /** @param {{Attachment?:Attachment[],AttachmentId?:string,TableName?:string,FieldName?:string,RecordId?:number,NeedsOCR?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Attachment[]} */
    Attachment = [];
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    TableName;
    /** @type {string} */
    FieldName;
    /** @type {number} */
    RecordId;
    /** @type {boolean} */
    NeedsOCR;
}

JavaScript 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
		}
	]
}