Query: allSoftwareComponents

General model for Software Components that contain common information and metadata about software that is common to all detected instances.. Note, individual instances of detected SoftwareComponents are represented by the SoftwareComponentInstance type. This model can be queried to see all instances of a software component that have been discovered.

Return Type




Args

NameTypeDescription
afterString

If this is set to the value of the _cursor field of an item, only items after that one will be included in the result. The value of the after of this query must match the one where the _cursor value has been retrieved from.

filterSoftwareComponentFilter
firstInt

The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).

orderBySoftwareComponentOrderBy

Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the after is specified or the _cursor is requested), id_ASC will be implicitly added as last sort criterion so that the sort order is deterministic.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_copyrightsMeta_QueryMeta

Copyright information for this software component

_cursorString

Provides a value that can be supplied to the after argument for pagination. Depends on the value of the orderBy argument.

_externalReferencesMeta_QueryMeta

External references and URLs for the component

_hashesMeta_QueryMeta

Independently reproducible mechanisms for identifying specific contents of a component or package based on the actual files

_instancesMeta_QueryMeta

The relationships to other components where this component is the "dest"

_licenseExceptionsMeta_QueryMeta

The license exceptions that apply to the software component

_licenseExpressionsMeta_QueryMeta
_licensesMeta_QueryMeta

The licenses that apply to the software component

_propertiesMeta_QueryMeta

Properties associated with this component. This is a free-form field that can be used to store additional information about the component.

_revisionID

An identifier that is updated automatically on each update of this root entity (but not on relation changes)

authorString

The author of this component

buildDateDateTime

The build date of this component

copyrights[Copyright]

Copyright information for this software component

createdAtDateTime

The instant this object has been created

detailedDescriptionString

The detailed description of this component

downloadLocationString

The download URL, or a specific location within a version control system (VCS) for the component or package

externalReferences[ExternalReference]

External references and URLs for the component

fileNameString

The actual file name of the component or package, or path of the directory being treated as a package.

filesAnalyzedBoolean

Indicated whether the files were analyzed for this package

groupString

The grouping name or identifier associated with this component. Examples include a Maven groupId or a Ruby Gem namespace.

hashes[Hash]

Independently reproducible mechanisms for identifying specific contents of a component or package based on the actual files

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

instances[SoftwareComponentInstance]

The relationships to other components where this component is the "dest"

isEndOfLifeBoolean

Deprecated. See supportEndOfLife for EOL data.

licenseExceptions[LicenseException]

The license exceptions that apply to the software component

licenseExpressions[LicenseExpression]
licenses[License]

The licenses that apply to the software component

mimeTypeString

The mime-type of this component

nameString

The name of the software component

originatorString

Identifies from where or whom the package originally came. In some cases, a package may be created and originally distributed by a different third part than the Package Supplier of the package

properties[KeyValuePair]

Properties associated with this component. This is a free-form field that can be used to store additional information about the component.

publisherString

The publisher of this component

releaseDateDateTime

The release date of this component

releaseNotesReleaseNotes

The notes associated with the software component release

scopeComponentScope

Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM

softwareIdentifiersSoftwareIdentifiers

The software identifiers associated with this software component

summaryDescriptionString

The summary description of this component

supplierOrganizationalEntity

The supplier associated with this component

supportEndOfLifeDateTime

The support end-of-life date for this component. Timestamp '1970-01-01T00:00:00Z' indicates an unknown end-of-life date that has already passed.

totalRiskFloat

The aggregated risk score of all instances of this component

typeSoftwareComponentType

The type of software component (e.g. application, library, framework, etc)

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)

urlString

The URL to the homepage of the provider of the software component

versionString

The version of the software component


This page was generated: 2024-11-06