Skip to main content
View as Markdown

BomHealthCheck

Health check description.

Member Of​

Bom interface ● BomIssue object ● BomRelease object ● BomWip object

type BomHealthCheck {
  category: BomHealthCheckCategory!
  description: String!
  group: String
  healthCheckId: String!
  howToFix: String
  label: String!
  provider: BomHealthCheckProvider!
  severity: BomHealthCheckSeverity!
}

Fields​

category ● BomHealthCheckCategory! non-null object​

Category the health check belongs to (e.g., *Supply Chain*, *Manufacturer Lifecycles*).

description ● String! non-null scalar​

Description of the health check (e.g., *This part is RoHS Non-Compliant*).

group ● String scalar​

If set, designates the name of a group the health check belongs to. E.g., the group might be named *RoHS status*, and the descriptions of the health checks in the group might be *No*, *Yes with Exemption*, and *Unknown*.

healthCheckId ● String! non-null scalar​

Health check identifier.

howToFix ● String scalar​

Recommended action to address the issue produced by the health check (e.g., *Consider using a different Manufacturer Part Number*).

label ● String! non-null scalar​

A concise label or tag for the health check. (e.g., *RoHS Non-Compliant*).

provider ● BomHealthCheckProvider! non-null object​

Provider of the health check.

severity ● BomHealthCheckSeverity! non-null enum​

Severity of the health check.