Trendsic Platform Service

<back to all web services

RecordsSearchRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/search
RecordsSearchRequest Parameters:
NameParameterData TypeRequiredDescription
QquerystringNo
PagequeryintNo
PageSizequeryintNo
RecordsSearchResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RecordsformList<RecordDto>No
RecordDto Parameters:
NameParameterData TypeRequiredDescription
RecordIdformintNo
RecordKeyformstringNo
NameformstringNo
SeriesIdformint?No
SeriesKeyformstringNo
ClassificationformstringNo
FormatformstringNo
PhaseformstringNo
TriggerDateformstringNo
StagedformboolNo
HoldIdformint?No
HoldKeyformstringNo
OwnerNameformstringNo
BranchformstringNo
BarcodeformstringNo
LocJsonformstringNo
MetaJsonformstringNo
FilesJsonformstringNo
VersionsJsonformstringNo
RelatedJsonformstringNo
DisposedJsonformstringNo
CreatedLabelformstringNo
UpdatedLabelformstringNo
LifecycleformstringNo
RetKindformstringNo
EligibleDateformstringNo
MonthsLeftformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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}]}