| 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<HoldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Holds>
<LegalHoldDto>
<FrozenJson>String</FrozenJson>
<HoldId>0</HoldId>
<HoldKey>String</HoldKey>
<LogJson>String</LogJson>
<Matches>
<HoldMatchDto>
<Name>String</Name>
<RecordKey>String</RecordKey>
<Tag>String</Tag>
<Warn>false</Warn>
</HoldMatchDto>
</Matches>
<Matter>String</Matter>
<Name>String</Name>
<PlacedBy>String</PlacedBy>
<PlacedLabel>String</PlacedLabel>
<Released>false</Released>
<ReleasedLabel>String</ReleasedLabel>
<ScopeDim>String</ScopeDim>
<ScopeLabel>String</ScopeLabel>
<ScopeNote>String</ScopeNote>
<ScopeVal>String</ScopeVal>
</LegalHoldDto>
</Holds>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</HoldsResponse>