Trendsic Platform Service

<back to all web services

TaskRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator
The following routes are available for this service:
DELETE,OPTIONS/v1/Task/{TaskId}
GET,POST,PUT,OPTIONS/v1/Task
"use strict";
export class Task {
    /** @param {{TaskId?:string,Description?:string,DueDate?:string,AssignedToAgentId?:number,RelatedToContactId?:number,CreatedBy?:number,DateCreated?:string,DateCompleted?:string,CompletedBy?:number,DateDeleted?:string,DeletedBy?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TaskId;
    /** @type {string} */
    Description;
    /** @type {string} */
    DueDate;
    /** @type {number} */
    AssignedToAgentId;
    /** @type {number} */
    RelatedToContactId;
    /** @type {number} */
    CreatedBy;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateCompleted;
    /** @type {number} */
    CompletedBy;
    /** @type {string} */
    DateDeleted;
    /** @type {number} */
    DeletedBy;
}
export class TaskExtended extends Task {
    /** @param {{AssignedToName?:string,RelatedToName?:string,TaskId?:string,Description?:string,DueDate?:string,AssignedToAgentId?:number,RelatedToContactId?:number,CreatedBy?:number,DateCreated?:string,DateCompleted?:string,CompletedBy?:number,DateDeleted?:string,DeletedBy?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    AssignedToName;
    /** @type {string} */
    RelatedToName;
}
export class TaskResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Task?:TaskExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {TaskExtended[]} */
    Task = [];
}
export class TaskRequest {
    /** @param {{Task?:TaskExtended,TaskId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TaskExtended} */
    Task;
    /** @type {string} */
    TaskId;
}

JavaScript TaskRequest 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/Task HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Task":{"AssignedToName":"String","RelatedToName":"String","TaskId":"00000000000000000000000000000000","Description":"String","DueDate":"0001-01-01T00:00:00.0000000","AssignedToAgentId":0,"RelatedToContactId":0,"CreatedBy":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateCompleted":"0001-01-01T00:00:00.0000000","CompletedBy":0,"DateDeleted":"0001-01-01T00:00:00.0000000","DeletedBy":0},"TaskId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Task":[{"AssignedToName":"String","RelatedToName":"String","TaskId":"00000000000000000000000000000000","Description":"String","DueDate":"0001-01-01T00:00:00.0000000","AssignedToAgentId":0,"RelatedToContactId":0,"CreatedBy":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateCompleted":"0001-01-01T00:00:00.0000000","CompletedBy":0,"DateDeleted":"0001-01-01T00:00:00.0000000","DeletedBy":0}]}