Trendsic Platform Service

<back to all web services

HoldPlaceRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/records/holds
"use strict";
export class RecordsOkResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Ok?:boolean,Id?:number,Key?:string,Matches?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Ok;
    /** @type {number} */
    Id;
    /** @type {string} */
    Key;
    /** @type {string[]} */
    Matches = [];
}
export class HoldPlaceRequest {
    /** @param {{Name?:string,Matter?:string,ScopeDim?:string,ScopeVal?:string,DryRun?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Matter;
    /** @type {string} */
    ScopeDim;
    /** @type {string} */
    ScopeVal;
    /** @type {boolean} */
    DryRun;
}

JavaScript HoldPlaceRequest DTOs

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.

POST /v1/records/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Name":"String","Matter":"String","ScopeDim":"String","ScopeVal":"String","DryRun":false}

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"}},"Ok":false,"Id":0,"Key":"String","Matches":["String"]}