| POST,OPTIONS | /v1/dashboard/project |
|---|
export class DashboardStatTile
{
public Key: string;
public Label: string;
public Value: number;
public PreviousValue?: number;
public Unit: string;
public DeltaPct?: number;
public constructor(init?: Partial<DashboardStatTile>) { (Object as any).assign(this, init); }
}
export class DashboardSeriesPoint
{
public Label: string;
public Value: number;
public constructor(init?: Partial<DashboardSeriesPoint>) { (Object as any).assign(this, init); }
}
export class DashboardSeries
{
public Name: string;
public Points: DashboardSeriesPoint[] = [];
public constructor(init?: Partial<DashboardSeries>) { (Object as any).assign(this, init); }
}
export class ProjectDashOverdueRow
{
public ProjectName: string;
public JobName: string;
public ExpectedCompletionDate: string;
public DaysOverdue: number;
public IsAtRisk: boolean;
public constructor(init?: Partial<ProjectDashOverdueRow>) { (Object as any).assign(this, init); }
}
export class ProjectDashRollupRow
{
public ProjectName: string;
public StatusName: string;
public JobCount: number;
public CompletedJobCount: number;
public TaskPct: number;
public MilestonePct: number;
public constructor(init?: Partial<ProjectDashRollupRow>) { (Object as any).assign(this, init); }
}
export class ProjectDashResponse
{
public ResponseStatus: ResponseStatus;
public Stats: DashboardStatTile[] = [];
public JobStatus: DashboardSeries;
public Throughput: DashboardSeries;
public CycleDistribution: DashboardSeries;
public Bottleneck: DashboardSeries;
public OverdueJobs: ProjectDashOverdueRow[] = [];
public Rollup: ProjectDashRollupRow[] = [];
public constructor(init?: Partial<ProjectDashResponse>) { (Object as any).assign(this, init); }
}
export class ProjectDashRequest
{
public FromDate: string;
public ToDate: string;
public constructor(init?: Partial<ProjectDashRequest>) { (Object as any).assign(this, init); }
}
TypeScript ProjectDashRequest 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.
POST /v1/dashboard/project HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromDate: 0001-01-01,
ToDate: 0001-01-01
}
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
}
},
Stats:
[
{
Key: String,
Label: String,
Value: 0,
PreviousValue: 0,
Unit: String
}
],
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
}
]
}