Trendsic Platform Service

<back to all web services

CoverageCascadeRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/cascade
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 CoveragePolicy:
    coverage_policy_id: int = 0
    coverage_policy_u_i_d: Optional[str] = None
    name: Optional[str] = None
    scope_level: Optional[str] = None
    branch_id: Optional[str] = None
    branch_name: Optional[str] = None
    work_type_key: Optional[str] = None
    job_i_d: Optional[int] = None
    job_name: Optional[str] = None
    current_version: int = 0
    is_active: bool = False
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRingDef:
    key: Optional[str] = None
    label: Optional[str] = None
    sub: Optional[str] = None
    wait_minutes: Optional[int] = None
    enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoveragePolicyPrefs:
    assignment_mode: Optional[str] = None
    rest_hours: int = 0
    ot_threshold_hours: int = 0
    ring_wait_minutes: int = 0
    quiet_start: Optional[str] = None
    quiet_end: Optional[str] = None
    reschedule_allowed: bool = False
    quiet_mode: Optional[str] = None
    rings: List[CoverageRingDef] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRuleDocSection:
    h: Optional[str] = None
    t: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRuleTuneOption:
    label: Optional[str] = None
    sub: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRuleTune:
    intro: Optional[str] = None
    options: List[CoverageRuleTuneOption] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRuleDef:
    rule_id: Optional[str] = None
    name: Optional[str] = None
    kind: Optional[str] = None
    demand: Optional[str] = None
    source_policy_name: Optional[str] = None
    cascade_level: Optional[str] = None
    why: Optional[str] = None
    change: Optional[str] = None
    override_who: Optional[str] = None
    override_consequence: Optional[str] = None
    no_note: Optional[str] = None
    params: Dict[str, str] = field(default_factory=dict)
    doc: List[CoverageRuleDocSection] = field(default_factory=list)
    tune: Optional[CoverageRuleTune] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoveragePolicyDoc:
    intro: Optional[str] = None
    lock_line: Optional[str] = None
    template_name: Optional[str] = None
    prefs: Optional[CoveragePolicyPrefs] = None
    rules: List[CoverageRuleDef] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoveragePolicyVersionInfo:
    coverage_policy_version_id: int = 0
    coverage_policy_id: int = 0
    version_number: int = 0
    change_note: Optional[str] = None
    changed_by_name: Optional[str] = None
    created_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    doc: Optional[CoveragePolicyDoc] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageCascadeResponse:
    policy: Optional[CoveragePolicy] = None
    doc: Optional[CoveragePolicyDoc] = None
    version_number: int = 0
    versions: List[CoveragePolicyVersionInfo] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageCascadeRequest:
    coverage_policy_id: Optional[int] = None
    version_number: Optional[int] = None

Python CoverageCascadeRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/coverage/cascade HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Policy":{"CoveragePolicyId":0,"CoveragePolicyUID":"00000000000000000000000000000000","Name":"String","ScopeLevel":"String","BranchId":"00000000000000000000000000000000","BranchName":"String","WorkTypeKey":"String","JobID":0,"JobName":"String","CurrentVersion":0,"IsActive":false,"CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"Doc":{"Intro":"String","LockLine":"String","TemplateName":"String","Prefs":{"AssignmentMode":"String","RestHours":0,"OtThresholdHours":0,"RingWaitMinutes":0,"QuietStart":"String","QuietEnd":"String","RescheduleAllowed":false,"QuietMode":"String","Rings":[{"Key":"String","Label":"String","Sub":"String","WaitMinutes":0,"Enabled":false}]},"Rules":[{"RuleId":"String","Name":"String","Kind":"String","Demand":"String","SourcePolicyName":"String","CascadeLevel":"String","Why":"String","Change":"String","OverrideWho":"String","OverrideConsequence":"String","NoNote":"String","Params":{"String":"String"},"Doc":[{"H":"String","T":"String"}],"Tune":{"Intro":"String","Options":[{"Label":"String","Sub":"String"}]}}]},"VersionNumber":0,"Versions":[{"CoveragePolicyVersionId":0,"CoveragePolicyId":0,"VersionNumber":0,"ChangeNote":"String","ChangedByName":"String","CreatedAtUtc":"0001-01-01T00:00:00.0000000","Doc":{"Intro":"String","LockLine":"String","TemplateName":"String","Prefs":{"AssignmentMode":"String","RestHours":0,"OtThresholdHours":0,"RingWaitMinutes":0,"QuietStart":"String","QuietEnd":"String","RescheduleAllowed":false,"QuietMode":"String","Rings":[{"Key":"String","Label":"String","Sub":"String","WaitMinutes":0,"Enabled":false}]},"Rules":[{"RuleId":"String","Name":"String","Kind":"String","Demand":"String","SourcePolicyName":"String","CascadeLevel":"String","Why":"String","Change":"String","OverrideWho":"String","OverrideConsequence":"String","NoNote":"String","Params":{"String":"String"},"Doc":[{"H":"String","T":"String"}],"Tune":{"Intro":"String","Options":[{"Label":"String","Sub":"String"}]}}]}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}