GET v1/bunits/{bunitId}/complianceSummaries/{year}/{month}?recalculate={recalculate}

Get the summary of a specified month

Request Information

URI Parameters

Name	Description	Type	Additional information
`bunitId`		integer	Required
`year`		integer	Required
`month`		integer	Required
`recalculate`	Deletes existing summaries and recalculates based on the goals available when first created	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ComplianceSummary

Name	Description	Type	Additional information
`Goal`	The goal relevant for the SLA of the business unit	decimal number	None.
`Date`	Date is always the last day of the month being covered.	date	None.
`JobsWithOk`		integer	None.
`JobsWithWarning`		integer	None.
`JobsWithError`		integer	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<ComplianceSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>6</Id>
  <CreatedDate>2024-09-14T20:58:03.1344845+02:00</CreatedDate>
  <ArchivedDate>2024-09-14T20:58:03.1344845+02:00</ArchivedDate>
  <Goal>1</Goal>
  <Date>2024-09-14T20:58:03.1344845+02:00</Date>
  <JobsWithOk>3</JobsWithOk>
  <JobsWithWarning>4</JobsWithWarning>
  <JobsWithError>5</JobsWithError>
</ComplianceSummary>