Trendsic Platform Service

<back to all web services

ProjectAttachmentRequest

The following routes are available for this service:
POST,OPTIONS/v1/Attachment/ProjectFiles/{TableName}/{FieldName}/{RecordId}
POST,OPTIONS/v1/Attachment/ProjectFiles/{TableName}/{FieldName}/{RecordId}/{NeedsOCR}
"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 ProjectAttachmentRequest {
    /** @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 ProjectAttachmentRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Attachment/ProjectFiles/{TableName}/{FieldName}/{RecordId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Attachment":[{"AttachmentId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"AttachmentName":"String","MimeType":"String","AttachmentData":"AA==","FileSizeInKB":0,"CreatedDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","NeedsOCR":false,"OCRDate":"0001-01-01T00:00:00.0000000","IsSecurities":false,"AWSKey":"String","PresignedUrl":"String"}],"AttachmentId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"NeedsOCR":false}

HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","CreatedBy":"String","NeedsOCR":false,"OCRDate":"0001-01-01T00:00:00.0000000","IsSecurities":false,"AWSKey":"String","PresignedUrl":"String"}]}