Query: flexSearchTests

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

filterTestFilter

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

flexSearchFilterTestFlexSearchFilter
orderByTestOrderBy

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.

postFilterTestFilter

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
_authorsMeta_QueryMeta

Authors of the test

_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 originating from this test

_processingStatusesMeta_QueryMeta

Any kind of processing currently occurring on the test

_revisionID

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

_softwareComponentsMeta_QueryMeta

All software component instances originating from this test

_toolsMeta_QueryMeta

The tools (also referred to as scanners) that were used to perform this test

artifactUnderTestArtifact

Which specific artifact was being tested

authors[Author]

Authors of the test

createdAtDateTime

The instant this object has been created

createdByUser

The user who configured this test in Finite State

ctxRelationEntityCtx

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

deletedAtDateTime

Timestamp of when this test/scan was deleted

descriptionString

Longer, optional description of this test

durationInt

Duration of time the test ran

findings[Finding]

All findings originating from this test

idID

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

inputTypeString

The type of input that was used for this test. This is an internal field that corresponds to the name of the ingest parser used. This is used to determine which fields to hash when computing the dedupeHash of Findings that result from this Test.

nameString

Name for this test. Will default to [tool.name | date]

parsedDateDateTime

Date and time that was parsed from the test results file

processingStatuses[ProcessingStatus]

Any kind of processing currently occurring on the test

softwareComponents[SoftwareComponentInstance]

All software component instances originating from this test

stateTestResultsProcessingState

The processing state of the test results file for this test

testIdString

Unique ID for this test as established by the testing tool.

testResultFileFormatString

File format of the test results file for this test

testResultFileLinkString

The file that can be ingested to get test results from this test.

testTypeTestType

The type of test

toolSettingsToolSettings

Settings that were used for this test

tools[TestingTool]

The tools (also referred to as scanners) that were used to perform this test

updatedAtDateTime

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

uploadMethodUploadMethod

Upload method used for this Test

userEnteredDateDateTime

Optional date and time specified by the user when the test was entered into the system


This page was generated: 2024-11-06