| GET,OPTIONS | /v1/dashboards/executive |
|---|
"use strict";
export class ExecKpi {
/** @param {{Key?:string,Label?:string,Value?:string,Sub_?:string,Delta?:string,DeltaUp?:boolean,HasDelta?:boolean,Good?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Label;
/** @type {string} */
Value;
/** @type {string} */
Sub_;
/** @type {string} */
Delta;
/** @type {boolean} */
DeltaUp;
/** @type {boolean} */
HasDelta;
/** @type {boolean} */
Good;
}
export class ExecCostCategory {
/** @param {{Name?:string,CostUSD?:number,BilledUSD?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {number} */
CostUSD;
/** @type {number} */
BilledUSD;
}
export class ExecMonthPoint {
/** @param {{Month?:string,RevenueUSD?:number,CostUSD?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Month;
/** @type {number} */
RevenueUSD;
/** @type {number} */
CostUSD;
}
export class ExecBacklogYear {
/** @param {{Year?:string,ValueUSD?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Year;
/** @type {number} */
ValueUSD;
}
export class ExecBacklog {
/** @param {{TotalUSD?:number,MonthsAhead?:number,AwardsYtdUSD?:number,BurnYtdUSD?:number,ByYear?:ExecBacklogYear[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TotalUSD;
/** @type {number} */
MonthsAhead;
/** @type {number} */
AwardsYtdUSD;
/** @type {number} */
BurnYtdUSD;
/** @type {ExecBacklogYear[]} */
ByYear = [];
}
export class ExecWipRow {
/** @param {{ContractId?:number,Name?:string,Owner?:string,ValueUSD?:number,PctComplete?:number,BilledUSD?:number,OverUnderUSD?:number,MarginPct?:number,FadePts?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContractId;
/** @type {string} */
Name;
/** @type {string} */
Owner;
/** @type {number} */
ValueUSD;
/** @type {number} */
PctComplete;
/** @type {number} */
BilledUSD;
/** @type {number} */
OverUnderUSD;
/** @type {number} */
MarginPct;
/** @type {number} */
FadePts;
}
export class ExecPipelineStage {
/** @param {{Stage?:string,ValueUSD?:number,Count?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Stage;
/** @type {number} */
ValueUSD;
/** @type {number} */
Count;
}
export class ExecAgingBucket {
/** @param {{Bucket?:string,AmountUSD?:number,IsRetainage?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Bucket;
/** @type {number} */
AmountUSD;
/** @type {boolean} */
IsRetainage;
}
export class ExecSafetyMetric {
/** @param {{Label?:string,Value?:string,Sub_?:string,Good?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Label;
/** @type {string} */
Value;
/** @type {string} */
Sub_;
/** @type {boolean} */
Good;
}
export class ExecutiveDashboard {
/** @param {{Period?:string,FromDate?:string,ToDate?:string,Fy?:number,Kpis?:ExecKpi[],CostVsBilling?:ExecCostCategory[],Monthly?:ExecMonthPoint[],Backlog?:ExecBacklog,Wip?:ExecWipRow[],Pipeline?:ExecPipelineStage[],WinRatePct?:number,Receivables?:ExecAgingBucket[],RetainageUSD?:number,DsoDays?:number,Safety?:ExecSafetyMetric[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Period;
/** @type {string} */
FromDate;
/** @type {string} */
ToDate;
/** @type {number} */
Fy;
/** @type {ExecKpi[]} */
Kpis = [];
/** @type {ExecCostCategory[]} */
CostVsBilling = [];
/** @type {ExecMonthPoint[]} */
Monthly = [];
/** @type {ExecBacklog} */
Backlog;
/** @type {ExecWipRow[]} */
Wip = [];
/** @type {ExecPipelineStage[]} */
Pipeline = [];
/** @type {number} */
WinRatePct;
/** @type {ExecAgingBucket[]} */
Receivables = [];
/** @type {number} */
RetainageUSD;
/** @type {number} */
DsoDays;
/** @type {ExecSafetyMetric[]} */
Safety = [];
}
export class ExecutiveDashboardResponse {
/** @param {{ResponseStatus?:ResponseStatus,Dashboard?:ExecutiveDashboard}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {ExecutiveDashboard} */
Dashboard;
}
export class ExecutiveDashboardRequest {
/** @param {{Period?:string,Region?:string,Fy?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Period;
/** @type {string} */
Region;
/** @type {?number} */
Fy;
}
JavaScript ExecutiveDashboardRequest 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/dashboards/executive HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
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
}
},
Dashboard:
{
Period: String,
FromDate: 0001-01-01,
ToDate: 0001-01-01,
Fy: 0,
Kpis:
[
{
Key: String,
Label: String,
Value: String,
Sub_: String,
Delta: String,
DeltaUp: False,
HasDelta: False,
Good: False
}
],
CostVsBilling:
[
{
Name: String,
CostUSD: 0,
BilledUSD: 0
}
],
Monthly:
[
{
Month: String,
RevenueUSD: 0,
CostUSD: 0
}
],
Backlog:
{
TotalUSD: 0,
MonthsAhead: 0,
AwardsYtdUSD: 0,
BurnYtdUSD: 0,
ByYear:
[
{
Year: String,
ValueUSD: 0
}
]
},
Wip:
[
{
ContractId: 0,
Name: String,
Owner: String,
ValueUSD: 0,
PctComplete: 0,
BilledUSD: 0,
OverUnderUSD: 0,
MarginPct: 0,
FadePts: 0
}
],
Pipeline:
[
{
Stage: String,
ValueUSD: 0,
Count: 0
}
],
WinRatePct: 0,
Receivables:
[
{
Bucket: String,
AmountUSD: 0,
IsRetainage: False
}
],
RetainageUSD: 0,
DsoDays: 0,
Safety:
[
{
Label: String,
Value: String,
Sub_: String,
Good: False
}
]
}
}