| POST,OPTIONS | /v1/import/{Type}/preview |
|---|
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 ImportRowResult:
line: int = 0
action: Optional[str] = None
field: Optional[str] = None
message: Optional[str] = None
summary: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImportResult:
import_type: Optional[str] = None
file_name: Optional[str] = None
dry_run: bool = False
import_batch_id: int = 0
total_rows: int = 0
new_rows: int = 0
updated_rows: int = 0
skipped_rows: int = 0
error_rows: int = 0
rows: List[ImportRowResult] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImportPreviewRequest:
type: Optional[str] = None
Python ImportPreviewRequest 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.
POST /v1/import/{Type}/preview HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Type: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ImportType: String,
FileName: String,
DryRun: False,
ImportBatchId: 0,
TotalRows: 0,
NewRows: 0,
UpdatedRows: 0,
SkippedRows: 0,
ErrorRows: 0,
Rows:
[
{
Line: 0,
Action: String,
Field: String,
Message: String,
Summary: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}