| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/AttachmentVersion/{AttachmentId}/{VersionNo}/restore |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttachmentVersion:
attachment_version_id: int = 0
attachment_id: Optional[str] = None
version_no: int = 0
attachment_name: Optional[str] = None
mime_type: Optional[str] = None
file_size_in_k_b: Optional[float] = None
aws_key: Optional[str] = None
revision_label: Optional[str] = None
notes: Optional[str] = None
restored_from_version_no: Optional[int] = None
uploaded_by: Optional[str] = None
uploaded_at: Optional[datetime.datetime] = None
is_current: bool = False
download_url: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Attachment:
attachment_id: Optional[str] = None
table_name: Optional[str] = None
field_name: Optional[str] = None
record_id: int = 0
attachment_name: Optional[str] = None
mime_type: Optional[str] = None
attachment_data: bytes = field(default_factory=list)
file_size_in_k_b: float = 0.0
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
created_by: Optional[str] = None
needs_o_c_r: bool = False
ocr_date: datetime.datetime = datetime.datetime(1, 1, 1)
is_securities: bool = False
aws_key: Optional[str] = None
presigned_url: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttachmentVersionResponse:
response_status: Optional[ResponseStatus] = None
attachment_id: Optional[str] = None
versions: List[AttachmentVersion] = field(default_factory=list)
current_version_no: int = 0
head: Optional[Attachment] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttachmentVersionRestoreRequest:
attachment_id: Optional[str] = None
version_no: int = 0
notes: Optional[str] = None
Python AttachmentVersionRestoreRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>