| GET,OPTIONS | /v1/records/holds |
|---|
import Foundation
import ServiceStack
public class HoldsRequest : Codable
{
required public init(){}
}
public class HoldsResponse : Codable
{
public var responseStatus:ResponseStatus
public var holds:[LegalHoldDto] = []
required public init(){}
}
public class LegalHoldDto : Codable
{
public var holdId:Int
public var holdKey:String
public var name:String
public var matter:String
public var scopeDim:String
public var scopeVal:String
public var scopeLabel:String
public var scopeNote:String
public var placedBy:String
public var placedLabel:String
public var released:Bool
public var releasedLabel:String
public var frozenJson:String
public var logJson:String
public var matches:[HoldMatchDto] = []
required public init(){}
}
public class HoldMatchDto : Codable
{
public var recordKey:String
public var name:String
public var tag:String
public var warn:Bool
required public init(){}
}
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/holds 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
}
},
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
}
]
}
]
}