| POST,OPTIONS | /v1/dashboard/project |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardStatTile:
key: Optional[str] = None
label: Optional[str] = None
value: float = 0.0
previous_value: Optional[float] = None
unit: Optional[str] = None
delta_pct: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardSeriesPoint:
label: Optional[str] = None
value: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardSeries:
name: Optional[str] = None
points: List[DashboardSeriesPoint] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectDashOverdueRow:
project_name: Optional[str] = None
job_name: Optional[str] = None
expected_completion_date: Optional[str] = None
days_overdue: int = 0
is_at_risk: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectDashRollupRow:
project_name: Optional[str] = None
status_name: Optional[str] = None
job_count: int = 0
completed_job_count: int = 0
task_pct: float = 0.0
milestone_pct: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectDashResponse:
response_status: Optional[ResponseStatus] = None
stats: List[DashboardStatTile] = field(default_factory=list)
job_status: Optional[DashboardSeries] = None
throughput: Optional[DashboardSeries] = None
cycle_distribution: Optional[DashboardSeries] = None
bottleneck: Optional[DashboardSeries] = None
overdue_jobs: List[ProjectDashOverdueRow] = field(default_factory=list)
rollup: List[ProjectDashRollupRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectDashRequest:
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
Python ProjectDashRequest DTOs
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
}
]
}