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