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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AttachmentVersionRestoreRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <Notes>String</Notes>
  <VersionNo>0</VersionNo>
</AttachmentVersionRestoreRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AttachmentVersionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <CurrentVersionNo>0</CurrentVersionNo>
  <Head>
    <AWSKey>String</AWSKey>
    <AttachmentData>AA==</AttachmentData>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <AttachmentName>String</AttachmentName>
    <CreatedBy>String</CreatedBy>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <FieldName>String</FieldName>
    <FileSizeInKB>0</FileSizeInKB>
    <IsSecurities>false</IsSecurities>
    <MimeType>String</MimeType>
    <NeedsOCR>false</NeedsOCR>
    <OCRDate>0001-01-01T00:00:00</OCRDate>
    <PresignedUrl>String</PresignedUrl>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
  </Head>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Versions>
    <AttachmentVersion>
      <AWSKey>String</AWSKey>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <AttachmentVersionId>0</AttachmentVersionId>
      <DownloadUrl>String</DownloadUrl>
      <FileSizeInKB>0</FileSizeInKB>
      <IsCurrent>false</IsCurrent>
      <MimeType>String</MimeType>
      <Notes>String</Notes>
      <RestoredFromVersionNo>0</RestoredFromVersionNo>
      <RevisionLabel>String</RevisionLabel>
      <UploadedAt>0001-01-01T00:00:00</UploadedAt>
      <UploadedBy>String</UploadedBy>
      <VersionNo>0</VersionNo>
    </AttachmentVersion>
  </Versions>
</AttachmentVersionResponse>