| GET,OPTIONS | /v1/records/search |
|---|
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 RecordDto:
record_id: int = 0
record_key: Optional[str] = None
name: Optional[str] = None
series_id: Optional[int] = None
series_key: Optional[str] = None
classification: Optional[str] = None
format: Optional[str] = None
phase: Optional[str] = None
trigger_date: Optional[str] = None
staged: bool = False
hold_id: Optional[int] = None
hold_key: Optional[str] = None
owner_name: Optional[str] = None
branch: Optional[str] = None
barcode: Optional[str] = None
loc_json: Optional[str] = None
meta_json: Optional[str] = None
files_json: Optional[str] = None
versions_json: Optional[str] = None
related_json: Optional[str] = None
disposed_json: Optional[str] = None
created_label: Optional[str] = None
updated_label: Optional[str] = None
lifecycle: Optional[str] = None
ret_kind: Optional[str] = None
eligible_date: Optional[str] = None
months_left: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordsSearchResponse:
response_status: Optional[ResponseStatus] = None
records: List[RecordDto] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordsSearchRequest:
q: Optional[str] = None
page: int = 0
page_size: int = 0
Python RecordsSearchRequest 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/records/search 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
}
},
Records:
[
{
RecordId: 0,
RecordKey: String,
Name: String,
SeriesId: 0,
SeriesKey: String,
Classification: String,
Format: String,
Phase: String,
TriggerDate: String,
Staged: False,
HoldId: 0,
HoldKey: String,
OwnerName: String,
Branch: String,
Barcode: String,
LocJson: String,
MetaJson: String,
FilesJson: String,
VersionsJson: String,
RelatedJson: String,
DisposedJson: String,
CreatedLabel: String,
UpdatedLabel: String,
Lifecycle: String,
RetKind: String,
EligibleDate: String,
MonthsLeft: 0
}
]
}