| GET,OPTIONS | /v1/Attachment/{TableName}/{FieldName}/{RecordId} |
|---|
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 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 AttachmentResponse:
response_status: Optional[ResponseStatus] = None
attachment: List[Attachment] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordAttachmentRequest:
table_name: Optional[str] = None
field_name: Optional[str] = None
record_id: int = 0
Python RecordAttachmentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Attachment/{TableName}/{FieldName}/{RecordId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
CreatedBy: String,
NeedsOCR: False,
OCRDate: 0001-01-01,
IsSecurities: False,
AWSKey: String,
PresignedUrl: String
}
]
}