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

export class ComplianceSummaryDto
{
    public Total: number;
    public Eligible: number;
    public Held: number;
    public Unscheduled: number;
    public PendingTrigger: number;
    public Running: number;
    public OverdueCheckouts: number;
    public OverdueRequests: number;
    public QaOpen: number;
    public RequestsOnTime90d: number;
    public Sessions90d: number;
    public Certs90d: number;

    public constructor(init?: Partial<ComplianceSummaryDto>) { (Object as any).assign(this, init); }
}

export class ComplianceExceptionDto
{
    public Kind: string;
    public Count: number;
    public RefRoute: string;

    public constructor(init?: Partial<ComplianceExceptionDto>) { (Object as any).assign(this, init); }
}

export class ComplianceSummaryResponse
{
    public ResponseStatus: ResponseStatus;
    public Summary: ComplianceSummaryDto;
    public Exceptions: ComplianceExceptionDto[] = [];

    public constructor(init?: Partial<ComplianceSummaryResponse>) { (Object as any).assign(this, init); }
}

export class ComplianceSummaryRequest
{

    public constructor(init?: Partial<ComplianceSummaryRequest>) { (Object as any).assign(this, init); }
}

TypeScript ComplianceSummaryRequest DTOs

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

HTTP + JSV

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: text/jsv
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
		}
	},
	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
		}
	]
}