| GET,OPTIONS | /v1/pm/projects |
|---|
"use strict";
export class PmProjectRow {
/** @param {{ProjectID?:number,ProjectUID?:string,Name?:string,Client?:string,ProjectType?:string,Status?:string,Branch?:string,StartDate?:string,EndDate?:string,Budget?:number,Spent?:number,EstimatedCost?:number,HealthPct?:number,JobCount?:number,OpenJobs?:number,GapCount?:number,OverBudget?:boolean,ProgressPct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ProjectID;
/** @type {string} */
ProjectUID;
/** @type {string} */
Name;
/** @type {string} */
Client;
/** @type {string} */
ProjectType;
/** @type {string} */
Status;
/** @type {string} */
Branch;
/** @type {string} */
StartDate;
/** @type {string} */
EndDate;
/** @type {number} */
Budget;
/** @type {number} */
Spent;
/** @type {number} */
EstimatedCost;
/** @type {number} */
HealthPct;
/** @type {number} */
JobCount;
/** @type {number} */
OpenJobs;
/** @type {number} */
GapCount;
/** @type {boolean} */
OverBudget;
/** @type {number} */
ProgressPct;
}
export class PmPortfolioTotals {
/** @param {{Projects?:number,Budget?:number,Spent?:number,OverBudget?:number,WithGaps?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Projects;
/** @type {number} */
Budget;
/** @type {number} */
Spent;
/** @type {number} */
OverBudget;
/** @type {number} */
WithGaps;
}
export class PmProjectsResponse {
/** @param {{Projects?:PmProjectRow[],Totals?:PmPortfolioTotals,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {PmProjectRow[]} */
Projects = [];
/** @type {PmPortfolioTotals} */
Totals;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class PmProjectsRequest {
/** @param {{Search?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Search;
}
JavaScript PmProjectsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/pm/projects HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Projects:
[
{
ProjectID: 0,
ProjectUID: String,
Name: String,
Client: String,
ProjectType: String,
Status: String,
Branch: String,
StartDate: String,
EndDate: String,
Budget: 0,
Spent: 0,
EstimatedCost: 0,
HealthPct: 0,
JobCount: 0,
OpenJobs: 0,
GapCount: 0,
OverBudget: False,
ProgressPct: 0
}
],
Totals:
{
Projects: 0,
Budget: 0,
Spent: 0,
OverBudget: 0,
WithGaps: 0
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}