Skip to main content
View as Markdown

BomRelease

Represents a release of the BOM (i.e., a snapshot of a work-in-progress BOM).

Common Data Model​

  • BOM Release — A static snapshot of a Managed BOM's data, saved under a release name with an incremented revision number and optional notes. The BOM Portal makes a release automatically when a Managed BOM is first created and again once its data has been mapped, and further releases can be made whenever needed. Each release moves through its own lifecycle states (by default Draft, Approved and Obsolete), and a Workspace can be configured to block releasing while the BOM has Error or Fatal Error issues.

Returned By​

bomBomRelease query

Member Of​

BomChangeBomReleaseLifecycleStatePayload object ● BomReleasesConnection object ● BomReleasesEdge object ● BomReleaseSource object

Interfaces​

Bom interface​

Represents a shared part of work-in-progress BOMs and releases of BOMs.

type BomRelease implements Bom {
  bomId: String!
  healthChecks: [BomHealthCheck!]!
  id: ID!
  incompleteHealthChecks: [BomHealthCheck!]!
  issues: [BomIssue!]!
  itemElementAttributes: [BomItemElementAttribute!]!
  items(
    after: String
    before: String
    first: Int
    last: Int
  ): BomItemsConnection
  lifeCycleDefinitionId: String!
  lifeCycleStateId: String!
  name: String!
  releasedAt: DateTime!
  releaseHrid: String!
  releaseId: String!
  releaseNotes: String!
  settings: BomSettings!
  sources: [BomSource!]!
}

Fields​

bomId ● String! non-null scalar​

Identifier of the BOM.

healthChecks ● [BomHealthCheck!]! non-null object​

Effective health checks applicable to this BOM.

id ● ID! non-null scalar​

Identifier of the BOM.

incompleteHealthChecks ● [BomHealthCheck!]! non-null object​

List of incomplete health checks. Some issues reported by these health checks may already be reported and included in the response, but the full set is still being processed and new issues may appear.

issues ● [BomIssue!]! non-null object​

Issues associated with the BOM.

itemElementAttributes ● [BomItemElementAttribute!]! non-null object​

A list of all custom BOM item element's attributes.

items ● BomItemsConnection object​

BOM items.

after ● String scalar​

Returns the elements in the list that come after the specified cursor.

before ● String scalar​

Returns the elements in the list that come before the specified cursor.

first ● Int scalar​

Returns the first _n_ elements from the list.

last ● Int scalar​

Returns the last _n_ elements from the list.

lifeCycleDefinitionId ● String! non-null scalar​

Identifier of the lifecycle definition used for this release.

lifeCycleStateId ● String! non-null scalar​

Identifier of the lifecycle state the release is in.

name ● String! non-null scalar​

Name of the BOM.

releasedAt ● DateTime! non-null scalar​

Timestamp of the release creation.

releaseHrid ● String! non-null scalar​

Human-readable identifier of the release.

releaseId ● String! non-null scalar​

Identifier of the release.

releaseNotes ● String! non-null scalar​

Release notes specified for the release.

settings ● BomSettings! non-null object​

Settings of the BOM (e.g., currency, production quantity, etc.).

sources ● [BomSource!]! non-null interface​

Sources of the BOM (e.g., a file, a design, or other BOMs).