Query: flexSearchSoftwareComponents
Queries for SoftwareComponents using FlexSearch.
Return Type
Related Types
Related Filters
Args
Name | Type | Description |
---|---|---|
after | String | If this is set to the value of the |
filter | SoftwareComponentFilter | Renamed to postFilter. Use postFilter instead. |
first | Int | 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). |
flexSearchExpression | String | |
flexSearchFilter | SoftwareComponentFlexSearchFilter | |
orderBy | SoftwareComponentOrderBy | 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 |
postFilter | SoftwareComponentFilter | Filters that will be applied in memory after the flexSearchFilter. This will not use any indices and will only work if applied on less than 10 000 objects. |
skip | Int | The number of items in the list or collection to skip. Is applied after the |
Properties
Name | Type | Description |
---|---|---|
_copyrightsMeta | _QueryMeta | Copyright information for this software component |
_cursor | String | Provides a value that can be supplied to the |
_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. |
_revision | ID | An identifier that is updated automatically on each update of this root entity (but not on relation changes) |
author | String | The author of this component |
buildDate | DateTime | The build date of this component |
copyrights | [Copyright] | Copyright information for this software component |
createdAt | DateTime | The instant this object has been created |
detailedDescription | String | The detailed description of this component |
downloadLocation | String | 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 |
fileName | String | The actual file name of the component or package, or path of the directory being treated as a package. |
filesAnalyzed | Boolean | Indicated whether the files were analyzed for this package |
group | String | 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 |
id | ID | 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" |
licenseExceptions | [LicenseException] | The license exceptions that apply to the software component |
licenseExpressions | [LicenseExpression] | |
licenses | [License] | The licenses that apply to the software component |
mimeType | String | The mime-type of this component |
name | String | The name of the software component |
originator | String | 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. |
publisher | String | The publisher of this component |
releaseDate | DateTime | The release date of this component |
releaseNotes | ReleaseNotes | The notes associated with the software component release |
scope | ComponentScope | Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM |
softwareIdentifiers | SoftwareIdentifiers | The software identifiers associated with this software component |
summaryDescription | String | The summary description of this component |
supplier | OrganizationalEntity | The supplier associated with this component |
supportEndOfLife | DateTime | The support end-of-life for this component |
totalRisk | Float | The aggregated risk score of all instances of this component |
type | SoftwareComponentType | The type of software component (e.g. application, library, framework, etc) |
updatedAt | DateTime | The instant this object has been updated the last time (not including relation updates) |
url | String | The URL to the homepage of the provider of the software component |
version | String | The version of the software component |
This page was generated: 2024-05-17