CYcyclonedx
TEA Component Release

Query TEA Component Releases

Changed on

Returns a list of TEA component releases. Note that multiple component releases may match.

get/componentReleases

Request

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

Query parameters

idType'CPE' | 'TEI' | 'PURL' | 'COMPLIANCE_DOCUMENT'

Enumeration of identifier types.

COMPLIANCE_DOCUMENT marks a TEA Component or TEA Component Release as carrying a compliance document (for example a SOC 2 report), so that it can be discovered with idType=COMPLIANCE_DOCUMENT on /components and /componentReleases; the document itself is published as a TEA Artifact of the component release. It shall not be used on products, product releases, distributions, or CLE events.

Type of identifier specified in the idValue parameter

idValuestring

If present, only the objects with the given identifier value will be returned.

pageSizeinteger

The maximum number of results to return.

pageTokenstring

An opaque continuation token produced by a previous response. This token shall be copied verbatim from the nextPageToken value returned by the previous response. Clients shall not parse, construct, or modify this token.

The token represents continuation state for the original query, including sortField, sortOrder, result-affecting filters such as idType and idValue, and path parameters such as parent uuid. When pageToken is supplied, clients shall not change those result-affecting query parameters. Servers shall return 400 Bad Request if supplied result-affecting query parameters conflict with the token state. To change any result-affecting parameter, clients shall start a new pagination sequence without pageToken.

A pageToken is only valid with the same request path and same path parameter values used to obtain it. Clients shall not reuse a pageToken across different parent resource paths or different path uuid values. Servers shall return 400 Bad Request when a pageToken is used with a different path or different path parameter values.

Servers shall return 400 Bad Request for malformed, invalid, expired, or conflicting pageToken values.

sortField'createdDate' | 'releaseDate' | 'version'

The field by which to sort the results.

Paginated results shall be ordered first by the selected sortField, then by uuid as a deterministic secondary tie-breaker.

When version is selected, ordering is by the stored version string according to the server's documented string collation; semantic-version precedence is not implied. Servers shall apply a stable and deterministic string collation for version sorting, and the same collation shall be used consistently across pages for a pagination sequence.

When releaseDate is selected, releases without a releaseDate shall be ordered consistently. Missing releaseDate values sort after populated releaseDate values for ascending order and before populated releaseDate values for descending order.

sortOrder'asc' | 'desc'

The direction of the sort.

The default is asc for all paginated resources. Clients that need newest release or collection versions first can request sortOrder=desc.

The selected sort order applies to both the primary sortField and the resource-specific deterministic secondary tie-breaker. For products, components, product releases, and component releases, the secondary key is uuid. For collections, the secondary key is version if additional tie-breaking is needed.

Response

A paginated response containing TEA Component Releases

hasNextboolean required

A flag indicating whether there is another page of results to fetch.

When hasNext is true, nextPageToken shall be present. When hasNext is false, nextPageToken shall not be included.

nextPageTokenstring

An opaque token that can be used in a following request to retrieve the next page of results.

This field shall be present when hasNext is true. This field shall not be included when hasNext is false.

Example response

{
  "hasNext": true,
  "nextPageToken": "eyJwYWdlIjoiY29udGludWF0aW9uIn0",
  "results": []
}

Changes

  • d56f299e3e44Revision changes
    • info

      api operation id queryTeaComponentReleases removed and replaced with queryComponentReleases

  • 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

      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