| GET,OPTIONS | /v1/records/holds |
|---|
export class HoldMatchDto
{
public RecordKey: string;
public Name: string;
public Tag: string;
public Warn: boolean;
public constructor(init?: Partial<HoldMatchDto>) { (Object as any).assign(this, init); }
}
export class LegalHoldDto
{
public HoldId: number;
public HoldKey: string;
public Name: string;
public Matter: string;
public ScopeDim: string;
public ScopeVal: string;
public ScopeLabel: string;
public ScopeNote: string;
public PlacedBy: string;
public PlacedLabel: string;
public Released: boolean;
public ReleasedLabel: string;
public FrozenJson: string;
public LogJson: string;
public Matches: HoldMatchDto[] = [];
public constructor(init?: Partial<LegalHoldDto>) { (Object as any).assign(this, init); }
}
export class HoldsResponse
{
public ResponseStatus: ResponseStatus;
public Holds: LegalHoldDto[] = [];
public constructor(init?: Partial<HoldsResponse>) { (Object as any).assign(this, init); }
}
export class HoldsRequest
{
public constructor(init?: Partial<HoldsRequest>) { (Object as any).assign(this, 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
}
]
}
]
}