Skip to content

Analyze coverage and gaps per item type

GET
/api/v1/traceability/coverage
curl --request GET \
--url 'https://app.avera.io/api/v1/traceability/coverage?projectId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Coverage per item type with the uncovered items as a gap list. Obsolete items are excluded unconditionally: these are measures of the live design, and the numerator, the denominator and the gap list have to agree.

projectId
required
string format: uuid
itemTypeId
string

OK

Media type*/*
object
summary
required
object
totalItems
required
integer format: int64
itemsWithUpstream
required
integer format: int64
itemsWithDownstream
required
integer format: int64
coveragePercent
required
number format: double
suspectLinkCount
required
integer format: int64
itemTypes
required
Array<object>
object
itemTypeId
required
string
itemTypeName
required
string
totalCount
required
integer format: int64
coveredCount
required
integer format: int64
coveragePercent
required
number format: double
gapCount
required
integer format: int64
gaps
required
Array<object>
object
itemId
required
string format: uuid
itemNumber
required
string
itemTitle
string | null
itemTypeId
required
string
itemTypeName
required
string
missingRelationships
required
Array<object>
object
relationshipTypeId
required
string
relationshipTypeName
required
string
direction
required
string