| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ExecutiveDashboardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Dashboard>
<Backlog>
<AwardsYtdUSD>0</AwardsYtdUSD>
<BurnYtdUSD>0</BurnYtdUSD>
<ByYear>
<ExecBacklogYear>
<ValueUSD>0</ValueUSD>
<Year>String</Year>
</ExecBacklogYear>
</ByYear>
<MonthsAhead>0</MonthsAhead>
<TotalUSD>0</TotalUSD>
</Backlog>
<CostVsBilling>
<ExecCostCategory>
<BilledUSD>0</BilledUSD>
<CostUSD>0</CostUSD>
<Name>String</Name>
</ExecCostCategory>
</CostVsBilling>
<DsoDays>0</DsoDays>
<FromDate>0001-01-01T00:00:00</FromDate>
<Fy>0</Fy>
<Kpis>
<ExecKpi>
<Delta>String</Delta>
<DeltaUp>false</DeltaUp>
<Good>false</Good>
<HasDelta>false</HasDelta>
<Key>String</Key>
<Label>String</Label>
<Sub_>String</Sub_>
<Value>String</Value>
</ExecKpi>
</Kpis>
<Monthly>
<ExecMonthPoint>
<CostUSD>0</CostUSD>
<Month>String</Month>
<RevenueUSD>0</RevenueUSD>
</ExecMonthPoint>
</Monthly>
<Period>String</Period>
<Pipeline>
<ExecPipelineStage>
<Count>0</Count>
<Stage>String</Stage>
<ValueUSD>0</ValueUSD>
</ExecPipelineStage>
</Pipeline>
<Receivables>
<ExecAgingBucket>
<AmountUSD>0</AmountUSD>
<Bucket>String</Bucket>
<IsRetainage>false</IsRetainage>
</ExecAgingBucket>
</Receivables>
<RetainageUSD>0</RetainageUSD>
<Safety>
<ExecSafetyMetric>
<Good>false</Good>
<Label>String</Label>
<Sub_>String</Sub_>
<Value>String</Value>
</ExecSafetyMetric>
</Safety>
<ToDate>0001-01-01T00:00:00</ToDate>
<WinRatePct>0</WinRatePct>
<Wip>
<ExecWipRow>
<BilledUSD>0</BilledUSD>
<ContractId>0</ContractId>
<FadePts>0</FadePts>
<MarginPct>0</MarginPct>
<Name>String</Name>
<OverUnderUSD>0</OverUnderUSD>
<Owner>String</Owner>
<PctComplete>0</PctComplete>
<ValueUSD>0</ValueUSD>
</ExecWipRow>
</Wip>
</Dashboard>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ExecutiveDashboardResponse>