Trendsic Platform Service

<back to all web services

ProjectDashRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/project
"use strict";
export class DashboardStatTile {
    /** @param {{Key?:string,Label?:string,Value?:number,PreviousValue?:number,Unit?:string,DeltaPct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
    /** @type {number} */
    Value;
    /** @type {?number} */
    PreviousValue;
    /** @type {string} */
    Unit;
    /** @type {?number} */
    DeltaPct;
}
export class DashboardSeriesPoint {
    /** @param {{Label?:string,Value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Label;
    /** @type {number} */
    Value;
}
export class DashboardSeries {
    /** @param {{Name?:string,Points?:DashboardSeriesPoint[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {DashboardSeriesPoint[]} */
    Points = [];
}
export class ProjectDashOverdueRow {
    /** @param {{ProjectName?:string,JobName?:string,ExpectedCompletionDate?:string,DaysOverdue?:number,IsAtRisk?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ProjectName;
    /** @type {string} */
    JobName;
    /** @type {string} */
    ExpectedCompletionDate;
    /** @type {number} */
    DaysOverdue;
    /** @type {boolean} */
    IsAtRisk;
}
export class ProjectDashRollupRow {
    /** @param {{ProjectName?:string,StatusName?:string,JobCount?:number,CompletedJobCount?:number,TaskPct?:number,MilestonePct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ProjectName;
    /** @type {string} */
    StatusName;
    /** @type {number} */
    JobCount;
    /** @type {number} */
    CompletedJobCount;
    /** @type {number} */
    TaskPct;
    /** @type {number} */
    MilestonePct;
}
export class ProjectDashResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Stats?:DashboardStatTile[],JobStatus?:DashboardSeries,Throughput?:DashboardSeries,CycleDistribution?:DashboardSeries,Bottleneck?:DashboardSeries,OverdueJobs?:ProjectDashOverdueRow[],Rollup?:ProjectDashRollupRow[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DashboardStatTile[]} */
    Stats = [];
    /** @type {DashboardSeries} */
    JobStatus;
    /** @type {DashboardSeries} */
    Throughput;
    /** @type {DashboardSeries} */
    CycleDistribution;
    /** @type {DashboardSeries} */
    Bottleneck;
    /** @type {ProjectDashOverdueRow[]} */
    OverdueJobs = [];
    /** @type {ProjectDashRollupRow[]} */
    Rollup = [];
}
export class ProjectDashRequest {
    /** @param {{FromDate?:string,ToDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FromDate;
    /** @type {string} */
    ToDate;
}

JavaScript ProjectDashRequest DTOs

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

HTTP + CSV

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

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

{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000"}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Stats":[{"Key":"String","Label":"String","Value":0,"PreviousValue":0,"Unit":"String","DeltaPct":null}],"JobStatus":{"Name":"String","Points":[{"Label":"String","Value":0}]},"Throughput":{"Name":"String","Points":[{"Label":"String","Value":0}]},"CycleDistribution":{"Name":"String","Points":[{"Label":"String","Value":0}]},"Bottleneck":{"Name":"String","Points":[{"Label":"String","Value":0}]},"OverdueJobs":[{"ProjectName":"String","JobName":"String","ExpectedCompletionDate":"String","DaysOverdue":0,"IsAtRisk":false}],"Rollup":[{"ProjectName":"String","StatusName":"String","JobCount":0,"CompletedJobCount":0,"TaskPct":0,"MilestonePct":0}]}