Trendsic Platform Service

<back to all web services

AgreementTasksRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/agreement/{AgreementID}/tasks
"use strict";
export class AgreementTask {
    /** @param {{AgreementTaskID?:number,AgreementID?:number,ServiceTaskID?:number,SortOrder?:number,Name?:string,Category?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementTaskID;
    /** @type {number} */
    AgreementID;
    /** @type {number} */
    ServiceTaskID;
    /** @type {number} */
    SortOrder;
    /** @type {string} */
    Name;
    /** @type {string} */
    Category;
    /** @type {boolean} */
    Active;
}
export class AgreementTasksResponse {
    /** @param {{Tasks?:AgreementTask[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AgreementTask[]} */
    Tasks = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class AgreementTasksRequest {
    /** @param {{AgreementID?:number,ServiceTaskIds?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
    /** @type {number[]} */
    ServiceTaskIds = [];
}

JavaScript AgreementTasksRequest 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.

PUT /v1/agreement/{AgreementID}/tasks HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgreementID: 0,
	ServiceTaskIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Tasks: 
	[
		{
			AgreementTaskID: 0,
			AgreementID: 0,
			ServiceTaskID: 0,
			SortOrder: 0,
			Name: String,
			Category: String,
			Active: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}