Trendsic Platform Service

<back to all web services

ComplianceSummaryRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/compliance/summary
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 ComplianceSummaryDto:
    total: int = 0
    eligible: int = 0
    held: int = 0
    unscheduled: int = 0
    pending_trigger: int = 0
    running: int = 0
    overdue_checkouts: int = 0
    overdue_requests: int = 0
    qa_open: int = 0
    requests_on_time90d: int = 0
    sessions90d: int = 0
    certs90d: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ComplianceExceptionDto:
    kind: Optional[str] = None
    count: int = 0
    ref_route: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ComplianceSummaryResponse:
    response_status: Optional[ResponseStatus] = None
    summary: Optional[ComplianceSummaryDto] = None
    exceptions: List[ComplianceExceptionDto] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ComplianceSummaryRequest:
    pass

Python ComplianceSummaryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/records/compliance/summary HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Summary":{"Total":0,"Eligible":0,"Held":0,"Unscheduled":0,"PendingTrigger":0,"Running":0,"OverdueCheckouts":0,"OverdueRequests":0,"QaOpen":0,"RequestsOnTime90d":0,"Sessions90d":0,"Certs90d":0},"Exceptions":[{"Kind":"String","Count":0,"RefRoute":"String"}]}