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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class AttachmentVersion implements IConvertible
{
    int? AttachmentVersionId;
    String? AttachmentId;
    int? VersionNo;
    String? AttachmentName;
    String? MimeType;
    double? FileSizeInKB;
    String? AWSKey;
    String? RevisionLabel;
    String? Notes;
    int? RestoredFromVersionNo;
    String? UploadedBy;
    DateTime? UploadedAt;
    bool? IsCurrent;
    String? DownloadUrl;

    AttachmentVersion({this.AttachmentVersionId,this.AttachmentId,this.VersionNo,this.AttachmentName,this.MimeType,this.FileSizeInKB,this.AWSKey,this.RevisionLabel,this.Notes,this.RestoredFromVersionNo,this.UploadedBy,this.UploadedAt,this.IsCurrent,this.DownloadUrl});
    AttachmentVersion.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AttachmentVersionId = json['AttachmentVersionId'];
        AttachmentId = json['AttachmentId'];
        VersionNo = json['VersionNo'];
        AttachmentName = json['AttachmentName'];
        MimeType = json['MimeType'];
        FileSizeInKB = JsonConverters.toDouble(json['FileSizeInKB']);
        AWSKey = json['AWSKey'];
        RevisionLabel = json['RevisionLabel'];
        Notes = json['Notes'];
        RestoredFromVersionNo = json['RestoredFromVersionNo'];
        UploadedBy = json['UploadedBy'];
        UploadedAt = JsonConverters.fromJson(json['UploadedAt'],'DateTime',context!);
        IsCurrent = json['IsCurrent'];
        DownloadUrl = json['DownloadUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AttachmentVersionId': AttachmentVersionId,
        'AttachmentId': AttachmentId,
        'VersionNo': VersionNo,
        'AttachmentName': AttachmentName,
        'MimeType': MimeType,
        'FileSizeInKB': FileSizeInKB,
        'AWSKey': AWSKey,
        'RevisionLabel': RevisionLabel,
        'Notes': Notes,
        'RestoredFromVersionNo': RestoredFromVersionNo,
        'UploadedBy': UploadedBy,
        'UploadedAt': JsonConverters.toJson(UploadedAt,'DateTime',context!),
        'IsCurrent': IsCurrent,
        'DownloadUrl': DownloadUrl
    };

    getTypeName() => "AttachmentVersion";
    TypeContext? context = _ctx;
}

class Attachment implements IConvertible
{
    String? AttachmentId;
    String? TableName;
    String? FieldName;
    int? RecordId;
    String? AttachmentName;
    String? MimeType;
    Uint8List? AttachmentData = [];
    double? FileSizeInKB;
    DateTime? CreatedDate;
    String? CreatedBy;
    bool? NeedsOCR;
    DateTime? OCRDate;
    bool? IsSecurities;
    String? AWSKey;
    String? PresignedUrl;

    Attachment({this.AttachmentId,this.TableName,this.FieldName,this.RecordId,this.AttachmentName,this.MimeType,this.AttachmentData,this.FileSizeInKB,this.CreatedDate,this.CreatedBy,this.NeedsOCR,this.OCRDate,this.IsSecurities,this.AWSKey,this.PresignedUrl});
    Attachment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AttachmentId = json['AttachmentId'];
        TableName = json['TableName'];
        FieldName = json['FieldName'];
        RecordId = json['RecordId'];
        AttachmentName = json['AttachmentName'];
        MimeType = json['MimeType'];
        AttachmentData = JsonConverters.fromJson(json['AttachmentData'],'Uint8List',context!);
        FileSizeInKB = JsonConverters.toDouble(json['FileSizeInKB']);
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        CreatedBy = json['CreatedBy'];
        NeedsOCR = json['NeedsOCR'];
        OCRDate = JsonConverters.fromJson(json['OCRDate'],'DateTime',context!);
        IsSecurities = json['IsSecurities'];
        AWSKey = json['AWSKey'];
        PresignedUrl = json['PresignedUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AttachmentId': AttachmentId,
        'TableName': TableName,
        'FieldName': FieldName,
        'RecordId': RecordId,
        'AttachmentName': AttachmentName,
        'MimeType': MimeType,
        'AttachmentData': JsonConverters.toJson(AttachmentData,'Uint8List',context!),
        'FileSizeInKB': FileSizeInKB,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'CreatedBy': CreatedBy,
        'NeedsOCR': NeedsOCR,
        'OCRDate': JsonConverters.toJson(OCRDate,'DateTime',context!),
        'IsSecurities': IsSecurities,
        'AWSKey': AWSKey,
        'PresignedUrl': PresignedUrl
    };

    getTypeName() => "Attachment";
    TypeContext? context = _ctx;
}

class AttachmentVersionResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    String? AttachmentId;
    List<AttachmentVersion>? Versions = [];
    int? CurrentVersionNo;
    Attachment? Head;

    AttachmentVersionResponse({this.ResponseStatus,this.AttachmentId,this.Versions,this.CurrentVersionNo,this.Head});
    AttachmentVersionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        AttachmentId = json['AttachmentId'];
        Versions = JsonConverters.fromJson(json['Versions'],'List<AttachmentVersion>',context!);
        CurrentVersionNo = json['CurrentVersionNo'];
        Head = JsonConverters.fromJson(json['Head'],'Attachment',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'AttachmentId': AttachmentId,
        'Versions': JsonConverters.toJson(Versions,'List<AttachmentVersion>',context!),
        'CurrentVersionNo': CurrentVersionNo,
        'Head': JsonConverters.toJson(Head,'Attachment',context!)
    };

    getTypeName() => "AttachmentVersionResponse";
    TypeContext? context = _ctx;
}

class AttachmentVersionRestoreRequest implements IConvertible
{
    String? AttachmentId;
    int? VersionNo;
    String? Notes;

    AttachmentVersionRestoreRequest({this.AttachmentId,this.VersionNo,this.Notes});
    AttachmentVersionRestoreRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AttachmentId = json['AttachmentId'];
        VersionNo = json['VersionNo'];
        Notes = json['Notes'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AttachmentId': AttachmentId,
        'VersionNo': VersionNo,
        'Notes': Notes
    };

    getTypeName() => "AttachmentVersionRestoreRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'AttachmentVersion': TypeInfo(TypeOf.Class, create:() => AttachmentVersion()),
    'Attachment': TypeInfo(TypeOf.Class, create:() => Attachment()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
    'AttachmentVersionResponse': TypeInfo(TypeOf.Class, create:() => AttachmentVersionResponse()),
    'List<AttachmentVersion>': TypeInfo(TypeOf.Class, create:() => <AttachmentVersion>[]),
    'AttachmentVersionRestoreRequest': TypeInfo(TypeOf.Class, create:() => AttachmentVersionRestoreRequest()),
});

Dart 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>