Trendsic Platform Service

<back to all web services

ProjectDashRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/project
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ProjectDashRequest
{
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var LocationIds:ArrayList<UUID> = ArrayList<UUID>()
}

open class ProjectDashResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Stats:ArrayList<DashboardStatTile> = ArrayList<DashboardStatTile>()
    open var JobStatus:DashboardSeries? = null
    open var Throughput:DashboardSeries? = null
    open var CycleDistribution:DashboardSeries? = null
    open var Bottleneck:DashboardSeries? = null
    open var OverdueJobs:ArrayList<ProjectDashOverdueRow> = ArrayList<ProjectDashOverdueRow>()
    open var Rollup:ArrayList<ProjectDashRollupRow> = ArrayList<ProjectDashRollupRow>()
    open var ByBranch:ArrayList<ProjectDashBranchRow> = ArrayList<ProjectDashBranchRow>()
}

open class DashboardStatTile
{
    open var Key:String? = null
    open var Label:String? = null
    open var Value:Double? = null
    open var PreviousValue:Double? = null
    open var Unit:String? = null
    open var DeltaPct:Double? = null
}

open class DashboardSeries
{
    open var Name:String? = null
    open var Points:ArrayList<DashboardSeriesPoint> = ArrayList<DashboardSeriesPoint>()
}

open class DashboardSeriesPoint
{
    open var Label:String? = null
    open var Value:Double? = null
}

open class ProjectDashOverdueRow
{
    open var ProjectName:String? = null
    open var JobName:String? = null
    open var ExpectedCompletionDate:String? = null
    open var DaysOverdue:Int? = null
    open var IsAtRisk:Boolean? = null
}

open class ProjectDashRollupRow
{
    open var ProjectName:String? = null
    open var StatusName:String? = null
    open var JobCount:Int? = null
    open var CompletedJobCount:Int? = null
    open var TaskPct:Double? = null
    open var MilestonePct:Double? = null
}

open class ProjectDashBranchRow
{
    open var BranchName:String? = null
    open var ActiveProjects:Int? = null
    open var ActiveJobs:Int? = null
    open var CompletedJobs:Int? = null
    open var OnTimePct:Double? = null
}

Kotlin ProjectDashRequest DTOs

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,
	LocationIds: 
	[
		00000000000000000000000000000000
	]
}
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
		}
	],
	ByBranch: 
	[
		{
			BranchName: String,
			ActiveProjects: 0,
			ActiveJobs: 0,
			CompletedJobs: 0,
			OnTimePct: 0
		}
	]
}