Sign in
TEA Component

Returns a list of TEA components. Note that multiple components may match.

get/components

Query parameters

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

Enumeration of identifiers types

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 MUST be copied verbatim from the nextPageToken value returned by the previous response. Clients MUST NOT parse, construct, or modify this token.

The token represents continuation state for the original query, including pageSize, sortField, sortOrder, result-affecting filters such as idType and idValue, and path parameters such as parent uuid. When pageToken is supplied, clients MUST NOT change those result-affecting query parameters. Servers MUST return 400 Bad Request if supplied result-affecting query parameters conflict with the token state. To change any result-affecting parameter, clients MUST 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 MUST NOT reuse a pageToken across different parent resource paths or different path uuid values. Servers MUST return 400 Bad Request when a pageToken is used with a different path or different path parameter values.

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

sortField'name'

The field by which to sort the results.

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

sortOrder'asc' | 'desc'

The direction of the sort.

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 Components

hasNextboolean required

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

When hasNext is true, nextPageToken MUST be present. When hasNext is false, nextPageToken MUST NOT be included.

nextPageTokenstring

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

This field MUST be present when hasNext is true. This field MUST NOT be included when hasNext is false.

Example response

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

Changes