| POST,OPTIONS | /v1/dashboard/project |
|---|
import Foundation
import ServiceStack
public class ProjectDashRequest : Codable
{
public var fromDate:Date
public var toDate:Date
required public init(){}
}
public class ProjectDashResponse : Codable
{
public var responseStatus:ResponseStatus
public var stats:[DashboardStatTile] = []
public var jobStatus:DashboardSeries
public var throughput:DashboardSeries
public var cycleDistribution:DashboardSeries
public var bottleneck:DashboardSeries
public var overdueJobs:[ProjectDashOverdueRow] = []
public var rollup:[ProjectDashRollupRow] = []
required public init(){}
}
public class DashboardStatTile : Codable
{
public var key:String
public var label:String
public var value:Double
public var previousValue:Double?
public var unit:String
public var deltaPct:Double?
required public init(){}
}
public class DashboardSeries : Codable
{
public var name:String
public var points:[DashboardSeriesPoint] = []
required public init(){}
}
public class DashboardSeriesPoint : Codable
{
public var label:String
public var value:Double
required public init(){}
}
public class ProjectDashOverdueRow : Codable
{
public var projectName:String
public var jobName:String
public var expectedCompletionDate:String
public var daysOverdue:Int
public var isAtRisk:Bool
required public init(){}
}
public class ProjectDashRollupRow : Codable
{
public var projectName:String
public var statusName:String
public var jobCount:Int
public var completedJobCount:Int
public var taskPct:Double
public var milestonePct:Double
required public init(){}
}
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.
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>