Sign in

v1

latestOpenAPI 3.1.1Apache 2.02026-07-17233761.2 KB
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 token used to retrieve the next page of results. This should be copied exactly from the nextPageToken field of a previous response.

sortField'name'

The field by which to sort the results.

sortOrder'asc' | 'desc'

The direction of the sort.

Response

A paginated response containing TEA Components

hasNextboolean required

A flag (to aid clients) to know whether there is a next page of results to fetch.

nextPageToken will always be supplied, hence this hint is included to aid clients.

nextPageTokenstring required

A token that can be used in a following request to retrieve the next page or results.

It must always be supplied in responses.

Example response

{
  "results": [
    {
      "uuid": "3910e0fd-aff4-48d6-b75f-8bf6b84687f0",
      "name": "Apache Log4j API",
      "identifiers": [
        {
          "idType": "PURL",
          "idValue": "pkg:maven/org.apache.logging.log4j/log4j-api"
        }
      ]
    }
  ]
}