Type: Artifact

The Artifact model

The Artifact model contains all the information about a Artifact, such as its name, description, and icon URL.

Querying for Artifacts

You can query for Artifacts using the allArtifacts query. This query takes a filter argument of type ArtifactFilter that you can use to filter the returned Artifacts.

Example

Getting all Artifacts that have a name that starts with "Energetic."

query AllEnergeticArtifacts(
  $filter: ArtifactFilter!
) {
  allArtifacts(
    filter: $filter
  ) {
    id
    name
    createdAt
  }
}

Example

Getting all Artifacts in a specific Business Unit. Note there are two separate example filters - one based on the Business Unit ID and one based on the Business Unit ID, the other based on the Business Unit Name.

query AllArtifactsInBusinessUnit (
  $filter: ArtifactFilter
  ) {
    allArtifacts(
      filter: $filter
    ) {
      id
      name
      createdAt
      businessUnits {
        id
        name
      }
    }
  }
}

An Artifact is a specific software repository, binary package, that is scanned by a specific security tool or scanner at a specific point in time. Artifacts must be uniquely identifiable, for example a source code repository at a specific commit hash, or a binary package with a specific version.

Properties

Name	Type	Description
_cursor	String	Provides a value that can be supplied to the `after` argument for pagination. Depends on the value of the `orderBy` argument.
_revision	ID	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.
artifactType	ArtifactType	Type of the artifact.
assetVersion	AssetVersion	The asset version this artifact is associated with
createdAt	DateTime	The instant this object has been created
createdBy	User	The user who created this artifact
ctx	RelationEntityCtx	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.
externalLinks	ArtifactLink	Links to get to the source artifact
fsanId	String	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.
id	ID	An auto-generated string that identifies this root entity uniquely among others of the same type
name	String	Name of the artifact
softwareIdentifiers	SoftwareIdentifiers	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.
updatedAt	DateTime	The instant this object has been updated the last time (not including relation updates)
version	String	Version of the artifact

This page was generated: 2024-11-06

Type: Artifact

The Artifact model

Querying for Artifacts

Example

Example

Related Inputs

Related Queries

Related Filters

Related Mutations

Properties