CYcyclonedx
TEA Artifact

Get the metadata of one TEA Artifact revision

Changed on

Get metadata for a specific revision of a specific TEA Artifact

get/artifact/{uuid}/{artifactVersion}

Request

  • Base URL
    http://localhost/tea/v1.0.0
  • Auth
    • HTTP bearer
    • or none

Path parameters

uuidstring uuid required

A UUID in lower case (RFC 9562)

UUID of TEA Artifact in the TEA server

artifactVersioninteger required

Version of TEA Artifact

Response

Requested TEA Artifact metadata found and returned

uuidstring uuid required

A UUID in lower case (RFC 9562)

versioninteger required

Revision number, starting at 1 and incremented by 1 for each new revision of the same artifact UUID. Together with uuid uniquely identifies the TEA Artifact. Successive revisions cover content changes and changes to any published field, including external url or signatureUrl values. Each published revision is immutable. For a fixed artifact UUID, version, and format, the server shall ensure that successful content retrieval through its download endpoint, including retrieval after following redirects, yields unchanged artifact bytes after HTTP transfer coding and content coding are removed, and that successful signature retrieval through its signature download endpoint yields unchanged signature bytes on the same terms. Changing only a download response's Location, or only its HTTP content coding, while preserving those bytes, does not require a new artifact or collection version.

namestring

A human-readable name for the artefact

type'ATTESTATION' | 'BOM' | 'BUILD_META' | 'CERTIFICATION' | 'FORMULATION' | 'LICENSE' | 'RELEASE_NOTES' | 'SECURITY_TXT' | 'THREAT_MODEL' | 'VULNERABILITIES' | 'OTHER' required

Type of TEA Artifact.

createdDatestring date-time required

Timestamp, RFC 3339 in UTC with the Z designator. Offsets are not accepted; servers shall convert to UTC before emitting. Fractional seconds are optional and preserved as sent. All timestamps in this specification use this schema.

distributionIdsUuid[]

Array of TEA Component Release distributions that this TEA Artifact applies to. If absent or empty, the TEA Artifact applies to all distributions.

Example response

{
  "uuid": "1cb47b95-8bf8-3bad-a5a4-0d54d86e10ce",
  "version": 2,
  "name": "Build SBOM",
  "type": "BOM",
  "createdDate": "2024-12-13T00:00:00Z",
  "formats": [
    {
      "mediaType": "application/vnd.cyclonedx+xml",
      "description": "CycloneDX SBOM (XML)",
      "url": "https://repo.maven.apache.org/maven2/org/apache/logging/log4j/log4j-core/2.24.3/log4j-core-2.24.3-cyclonedx.xml",
      "signatureUrl": "https://repo.maven.apache.org/maven2/org/apache/logging/log4j/log4j-core/2.24.3/log4j-core-2.24.3-cyclonedx.xml.asc",
      "checksums": [
        {
          "algType": "SHA-256",
          "algValue": "e04c9d55986d7194822eaa4f8115a77f801844d807ad6e0d454ac31dd41861e5"
        },
        {
          "algType": "SHA-1",
          "algValue": "5a7d4caef63c5c5ccdf07c39337323529eb5a770"
        }
      ]
    }
  ]
}

Changes

  • e476cd640edcRevision changes
    • info

      the / response property dependentRequired was added for the status : when url is present, checksums are required

  • f698addb5d2bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value 1 was removed for the status

    • info

      removed the OBJECT_NOT_SHAREABLE enum value from the response property for the response status

    • info

      removed the OBJECT_NOT_SHAREABLE enum value from the response property for the response status

    • info

      removed the OBJECT_NOT_SHAREABLE enum value from the response property for the response status

    • info

      removed the OBJECT_NOT_SHAREABLE enum value from the response property for the response status