Trendsic Platform Service

ProjectDashRequest

The following routes are available for this service:
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 .xml suffix or ?format=xml

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