CYcyclonedx
TEA Collection

List the collections of a TEA Product Release

Changed on

Get the TEA Collections belonging to the TEA Product Release

get/productRelease/{uuid}/collections

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 Product Release in the TEA server

Query parameters

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'version'

The field by which to sort the results.

Paginated collection results shall be ordered first by the selected sortField, then by version as the deterministic secondary key if additional tie-breaking is needed. Collection UUIDs are not used as tie-breakers because collection UUIDs match the associated release UUID and can be shared across collection revisions.

The only currently supported collection sortField is version, so the secondary version key is redundant unless additional collection sort fields are added later.

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 Collections

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

  • c69063d1dfffRevision changes
    • info

      api tag TEA Collection added

    • info

      api tag TEA Product Release removed

  • e476cd640edcRevision changes
    • info

      api tag TEA Product Release added

    • info

      api tag TEA Collection removed

    • info

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