Trendsic Platform Service

<back to all web services

ProjectDashRequest

"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

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

<ProjectDashRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ToDate>0001-01-01T00:00:00</ToDate>
</ProjectDashRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectDashResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Bottleneck>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </Bottleneck>
  <CycleDistribution>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </CycleDistribution>
  <JobStatus>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </JobStatus>
  <OverdueJobs>
    <ProjectDashOverdueRow>
      <DaysOverdue>0</DaysOverdue>
      <ExpectedCompletionDate>String</ExpectedCompletionDate>
      <IsAtRisk>false</IsAtRisk>
      <JobName>String</JobName>
      <ProjectName>String</ProjectName>
    </ProjectDashOverdueRow>
  </OverdueJobs>
  <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>
  <Rollup>
    <ProjectDashRollupRow>
      <CompletedJobCount>0</CompletedJobCount>
      <JobCount>0</JobCount>
      <MilestonePct>0</MilestonePct>
      <ProjectName>String</ProjectName>
      <StatusName>String</StatusName>
      <TaskPct>0</TaskPct>
    </ProjectDashRollupRow>
  </Rollup>
  <Stats>
    <DashboardStatTile>
      <Key>String</Key>
      <Label>String</Label>
      <PreviousValue>0</PreviousValue>
      <Unit>String</Unit>
      <Value>0</Value>
    </DashboardStatTile>
  </Stats>
  <Throughput>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </Throughput>
</ProjectDashResponse>