| POST,OPTIONS | /v1/dashboard/project |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FromDate | body | DateTime | No | |
| ToDate | body | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Stats | form | List<DashboardStatTile> | No | |
| JobStatus | form | DashboardSeries | No | |
| Throughput | form | DashboardSeries | No | |
| CycleDistribution | form | DashboardSeries | No | |
| Bottleneck | form | DashboardSeries | No | |
| OverdueJobs | form | List<ProjectDashOverdueRow> | No | |
| Rollup | form | List<ProjectDashRollupRow> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Label | form | string | No | |
| Value | form | double | No | |
| PreviousValue | form | double? | No | |
| Unit | form | string | No | |
| DeltaPct | form | double? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Points | form | List<DashboardSeriesPoint> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | No | |
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProjectName | form | string | No | |
| JobName | form | string | No | |
| ExpectedCompletionDate | form | string | No | |
| DaysOverdue | form | int | No | |
| IsAtRisk | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProjectName | form | string | No | |
| StatusName | form | string | No | |
| JobCount | form | int | No | |
| CompletedJobCount | form | int | No | |
| TaskPct | form | double | No | |
| MilestonePct | form | double | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}