Trendsic Platform Service

<back to all web services

AttachmentVersionRestoreRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/AttachmentVersion/{AttachmentId}/{VersionNo}/restore
"use strict";
export class AttachmentVersion {
    /** @param {{AttachmentVersionId?:number,AttachmentId?:string,VersionNo?:number,AttachmentName?:string,MimeType?:string,FileSizeInKB?:number,AWSKey?:string,RevisionLabel?:string,Notes?:string,RestoredFromVersionNo?:number,UploadedBy?:string,UploadedAt?:string,IsCurrent?:boolean,DownloadUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AttachmentVersionId;
    /** @type {string} */
    AttachmentId;
    /** @type {number} */
    VersionNo;
    /** @type {string} */
    AttachmentName;
    /** @type {string} */
    MimeType;
    /** @type {?number} */
    FileSizeInKB;
    /** @type {string} */
    AWSKey;
    /** @type {string} */
    RevisionLabel;
    /** @type {string} */
    Notes;
    /** @type {?number} */
    RestoredFromVersionNo;
    /** @type {string} */
    UploadedBy;
    /** @type {?string} */
    UploadedAt;
    /** @type {boolean} */
    IsCurrent;
    /** @type {string} */
    DownloadUrl;
}
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 AttachmentVersionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AttachmentId?:string,Versions?:AttachmentVersion[],CurrentVersionNo?:number,Head?:Attachment}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {string} */
    AttachmentId;
    /** @type {AttachmentVersion[]} */
    Versions = [];
    /** @type {number} */
    CurrentVersionNo;
    /** @type {Attachment} */
    Head;
}
export class AttachmentVersionRestoreRequest {
    /** @param {{AttachmentId?:string,VersionNo?:number,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {number} */
    VersionNo;
    /** @type {string} */
    Notes;
}

JavaScript AttachmentVersionRestoreRequest DTOs

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

HTTP + OTHER

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

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

{"AttachmentId":"00000000000000000000000000000000","VersionNo":0,"Notes":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","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-01T00:00:00.0000000","CreatedBy":"String","NeedsOCR":false,"OCRDate":"0001-01-01T00:00:00.0000000","IsSecurities":false,"AWSKey":"String","PresignedUrl":"String"}}