Query: flexSearchArtifacts

Queries for Artifacts 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.

filterArtifactFilter

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

flexSearchFilterArtifactFlexSearchFilter
orderByArtifactOrderBy

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.

postFilterArtifactFilter

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
_cursorString

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

_revisionID

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

_testsMeta_QueryMeta

All tests / scans performed on this artifact. Note that this is a list of tests, not a list of test results. A test may have multiple results, and a test may be performed multiple times.

artifactTypeArtifactType

Type of the artifact.

assetVersionAssetVersion

The asset version this artifact is associated with

createdAtDateTime

The instant this object has been created

createdByUser

The user who created this artifact

ctxRelationEntityCtx

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

externalLinksArtifactLink

Links to get to the source artifact

fsanIdString

The fsan_id associated with this Artifact. The fsan_id is used by Finite State Binary Analysis to uniquely identify an artifact and its processing.

idID

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

nameString

Name of the artifact

softwareIdentifiersSoftwareIdentifiers

A list of unique identifiers for this artifact. In the case of a single project, this may be a Package URL (purl). Software Identifiers are used to link an object to known vulnerabilities (e.g. CVEs).

tests[Test]

All tests / scans performed on this artifact. Note that this is a list of tests, not a list of test results. A test may have multiple results, and a test may be performed multiple times.

updatedAtDateTime

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

versionString

Version of the artifact


This page was generated: 2024-11-06