Trendsic Platform Service

<back to all web services

HoldsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/holds
HoldsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
HoldsformList<LegalHoldDto>No
LegalHoldDto Parameters:
NameParameterData TypeRequiredDescription
HoldIdformintNo
HoldKeyformstringNo
NameformstringNo
MatterformstringNo
ScopeDimformstringNo
ScopeValformstringNo
ScopeLabelformstringNo
ScopeNoteformstringNo
PlacedByformstringNo
PlacedLabelformstringNo
ReleasedformboolNo
ReleasedLabelformstringNo
FrozenJsonformstringNo
LogJsonformstringNo
MatchesformList<HoldMatchDto>No
HoldMatchDto Parameters:
NameParameterData TypeRequiredDescription
RecordKeyformstringNo
NameformstringNo
TagformstringNo
WarnformboolNo

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/holds 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"}},"Holds":[{"HoldId":0,"HoldKey":"String","Name":"String","Matter":"String","ScopeDim":"String","ScopeVal":"String","ScopeLabel":"String","ScopeNote":"String","PlacedBy":"String","PlacedLabel":"String","Released":false,"ReleasedLabel":"String","FrozenJson":"String","LogJson":"String","Matches":[{"RecordKey":"String","Name":"String","Tag":"String","Warn":false}]}]}