Trendsic Platform Service

<back to all web services

AgentTaskRequest

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/AgentTask/{TaskId}
GET,POST,PUT,OPTIONS/v1/AgentTask
"use strict";
export class AgentTask {
    /** @param {{TaskId?:string,Description?:string,DueDate?:string,AssignedToAgentId?:number,RelatedToAgentId?: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} */
    RelatedToAgentId;
    /** @type {number} */
    CreatedBy;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateCompleted;
    /** @type {number} */
    CompletedBy;
    /** @type {string} */
    DateDeleted;
    /** @type {number} */
    DeletedBy;
}
export class AgentTaskExtended extends AgentTask {
    /** @param {{AssignedToName?:string,RelatedToName?:string,TaskId?:string,Description?:string,DueDate?:string,AssignedToAgentId?:number,RelatedToAgentId?: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 AgentTaskResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Task?:AgentTaskExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentTaskExtended[]} */
    Task = [];
}
export class AgentTaskRequest {
    /** @param {{Task?:AgentTaskExtended,TaskId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AgentTaskExtended} */
    Task;
    /** @type {string} */
    TaskId;
}

JavaScript AgentTaskRequest DTOs

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

HTTP + JSV

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

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

{
	Task: 
	{
		AssignedToName: String,
		RelatedToName: String,
		TaskId: 00000000000000000000000000000000,
		Description: String,
		DueDate: 0001-01-01,
		AssignedToAgentId: 0,
		RelatedToAgentId: 0,
		CreatedBy: 0,
		DateCreated: 0001-01-01,
		DateCompleted: 0001-01-01,
		CompletedBy: 0,
		DateDeleted: 0001-01-01,
		DeletedBy: 0
	},
	TaskId: 00000000000000000000000000000000
}
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
		}
	},
	Task: 
	[
		{
			AssignedToName: String,
			RelatedToName: String,
			TaskId: 00000000000000000000000000000000,
			Description: String,
			DueDate: 0001-01-01,
			AssignedToAgentId: 0,
			RelatedToAgentId: 0,
			CreatedBy: 0,
			DateCreated: 0001-01-01,
			DateCompleted: 0001-01-01,
			CompletedBy: 0,
			DateDeleted: 0001-01-01,
			DeletedBy: 0
		}
	]
}