Trendsic Platform Service

DispatchHoldCreateRequest

**Requires Authentication**
Requires any of the permissions:	DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/holds

"use strict";
export class DispatchHoldView {
    /** @param {{HoldId?:number,Code?:string,ScopeKind?:string,ScopeKey?:string,ScopeLabel?:string,Reason?:string,Note?:string,StartUtc?:string,EndUtc?:string,Source?:string,IncidentRef?:string,LiftedUtc?:string,LiftedBy?:string,CreatedUtc?:string,CreatedBy?:string,Status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    HoldId;
    /** @type {string} */
    Code;
    /** @type {string} */
    ScopeKind;
    /** @type {string} */
    ScopeKey;
    /** @type {string} */
    ScopeLabel;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Note;
    /** @type {string} */
    StartUtc;
    /** @type {string} */
    EndUtc;
    /** @type {string} */
    Source;
    /** @type {string} */
    IncidentRef;
    /** @type {?string} */
    LiftedUtc;
    /** @type {string} */
    LiftedBy;
    /** @type {?string} */
    CreatedUtc;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    Status;
}
export class DispatchOfflineWindowView {
    /** @param {{OfflineWindowId?:number,FromHour?:string,ToHour?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    OfflineWindowId;
    /** @type {string} */
    FromHour;
    /** @type {string} */
    ToHour;
}
export class DispatchHoldScopeView {
    /** @param {{Kind?:string,Key?:string,Label?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
}
export class DispatchHoldSuggestionView {
    /** @param {{ForDate?:string,Kind?:string,Severity?:number,Headline?:string,DayLabel?:string,ScopeKind?:string,ScopeLabel?:string,Reason?:string,StartUtc?:string,EndUtc?:string,WindowLocal?:string,Text?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ForDate;
    /** @type {string} */
    Kind;
    /** @type {number} */
    Severity;
    /** @type {string} */
    Headline;
    /** @type {string} */
    DayLabel;
    /** @type {string} */
    ScopeKind;
    /** @type {string} */
    ScopeLabel;
    /** @type {string} */
    Reason;
    /** @type {string} */
    StartUtc;
    /** @type {string} */
    EndUtc;
    /** @type {string} */
    WindowLocal;
    /** @type {string} */
    Text;
}
export class DispatchHoldsResponse {
    /** @param {{Holds?:DispatchHoldView[],Windows?:DispatchOfflineWindowView[],Scopes?:DispatchHoldScopeView[],Suggestion?:DispatchHoldSuggestionView,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DispatchHoldView[]} */
    Holds = [];
    /** @type {DispatchOfflineWindowView[]} */
    Windows = [];
    /** @type {DispatchHoldScopeView[]} */
    Scopes = [];
    /** @type {DispatchHoldSuggestionView} */
    Suggestion;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchHoldCreateRequest {
    /** @param {{ScopeKind?:string,ScopeKey?:string,ScopeLabel?:string,Reason?:string,Note?:string,StartUtc?:string,EndUtc?:string,SuggestionDate?:string,SuggestionKind?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ScopeKind;
    /** @type {string} */
    ScopeKey;
    /** @type {string} */
    ScopeLabel;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Note;
    /** @type {string} */
    StartUtc;
    /** @type {string} */
    EndUtc;
    /** @type {string} */
    SuggestionDate;
    /** @type {string} */
    SuggestionKind;
}

JavaScript DispatchHoldCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dispatch/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ScopeKind":"String","ScopeKey":"String","ScopeLabel":"String","Reason":"String","Note":"String","StartUtc":"String","EndUtc":"String","SuggestionDate":"String","SuggestionKind":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Holds":[{"HoldId":0,"Code":"String","ScopeKind":"String","ScopeKey":"String","ScopeLabel":"String","Reason":"String","Note":"String","StartUtc":"0001-01-01T00:00:00.0000000","EndUtc":"0001-01-01T00:00:00.0000000","Source":"String","IncidentRef":"String","LiftedUtc":"0001-01-01T00:00:00.0000000","LiftedBy":"String","CreatedUtc":"0001-01-01T00:00:00.0000000","CreatedBy":"String","Status":"String"}],"Windows":[{"OfflineWindowId":0,"FromHour":"String","ToHour":"String"}],"Scopes":[{"Kind":"String","Key":"String","Label":"String"}],"Suggestion":{"ForDate":"String","Kind":"String","Severity":0,"Headline":"String","DayLabel":"String","ScopeKind":"String","ScopeLabel":"String","Reason":"String","StartUtc":"0001-01-01T00:00:00.0000000","EndUtc":"0001-01-01T00:00:00.0000000","WindowLocal":"String","Text":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}