Query: flexSearchAssetVersions

Queries for AssetVersions using FlexSearch.

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.

filterAssetVersionFilter

Renamed to postFilter. Use postFilter instead.

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).

flexSearchExpressionString
flexSearchFilterAssetVersionFlexSearchFilter
orderByAssetVersionOrderBy

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.

postFilterAssetVersionFilter

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.

skipInt

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


Properties

NameTypeDescription
_artifactsMeta_QueryMeta

All artifacts related to this asset version

_cursorString

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

_findingsMeta_QueryMeta

All Findings related to this asset version

_processingStatusesMeta_QueryMeta

Any kind of processing currently occurring on the asset version

_productsMeta_QueryMeta

All products related to this asset version

_revisionID

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

_softwareComponentInstancesMeta_QueryMeta

All software component instances related to this asset version. This is effectively the SBOM for the Asset Version.

_uniqueTestTypesMeta_QueryMeta

The collection of unique testing tools for this asset version (e.g. Finite State Binary Analysis, Snyk Scan, etc.). This is used to determine which tools have been used to scan the Artifacts in this asset version.

absoluteRiskScoreFloat

The Absolute Risk Score for this asset version. For details about Absolute Risk Score see the documentation about Risk Scores.

artifacts[Artifact]

All artifacts related to this asset version

assetAsset

The corresponding Asset for this version.

createdAtDateTime

The instant this object has been created

createdByUser

The user who created this AssetVersion. This is automatically set by the system at the time of creation and cannot be modified.

ctxRelationEntityCtx

Context contains fields that are accesible to the permissions profile. This is an internal field related to user permissions.

deletedAtDateTime

Timestamp of when this asset version was deleted

findings[Finding]

All Findings related to this asset version

fsanIds[String]

The fsan_id's associated with all Artifacts that have been uploaded to this Asset Version.

idID

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

nameString

Name of the asset version. This is usually the version number, such as 1.0.0.

positionInt

The position in which this asset version is relative to other version in this asset

processingStatuses[ProcessingStatus]

Any kind of processing currently occurring on the asset version

products[Product]

All products related to this asset version

relativeRiskScoreFloat

The Absolute Risk Score for this asset version. For details about Absolute Risk Score see the documentation about Risk Scores.

softwareComponentInstances[SoftwareComponentInstance]

All software component instances related to this asset version. This is effectively the SBOM for the Asset Version.

testStatuses[TestResultsProcessingStatus]

The status of the tests / scans that have been run on Artifacts in this asset version

uniqueTestTypes[TestingTool]

The collection of unique testing tools for this asset version (e.g. Finite State Binary Analysis, Snyk Scan, etc.). This is used to determine which tools have been used to scan the Artifacts in this asset version.

updatedAtDateTime

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


This page was generated: 2024-05-17