Trendsic Platform Service

<back to all web services

ProjectDashRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/project
ProjectDashRequest Parameters:
NameParameterData TypeRequiredDescription
FromDatebodyDateTimeNo
ToDatebodyDateTimeNo
ProjectDashResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
StatsformList<DashboardStatTile>No
JobStatusformDashboardSeriesNo
ThroughputformDashboardSeriesNo
CycleDistributionformDashboardSeriesNo
BottleneckformDashboardSeriesNo
OverdueJobsformList<ProjectDashOverdueRow>No
RollupformList<ProjectDashRollupRow>No
DashboardStatTile Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
LabelformstringNo
ValueformdoubleNo
PreviousValueformdouble?No
UnitformstringNo
DeltaPctformdouble?No
DashboardSeries Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PointsformList<DashboardSeriesPoint>No
DashboardSeriesPoint Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ValueformdoubleNo
ProjectDashOverdueRow Parameters:
NameParameterData TypeRequiredDescription
ProjectNameformstringNo
JobNameformstringNo
ExpectedCompletionDateformstringNo
DaysOverdueformintNo
IsAtRiskformboolNo
ProjectDashRollupRow Parameters:
NameParameterData TypeRequiredDescription
ProjectNameformstringNo
StatusNameformstringNo
JobCountformintNo
CompletedJobCountformintNo
TaskPctformdoubleNo
MilestonePctformdoubleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	]
}