Get Releases By Large Set Values

Return a paginated list releases in a specific catalog for an organization filtered by a potential large set of values order by release date descending. The id of the organization is fetched from CSP token

Request

URI

POST

https://{api_host}/v1/catalogs/{catalog_id}/releases

COPY

Path Parameters

CatalogId

catalog_id

Required

A string as the identifier of a catalog

Request Body

List of values that will be searched by

ReleasePostFilter of type(s) application/json

Required

"ReleasePostFilter Object"

array of string

spdx_report_ids

Optional

Release metadata id, which is the hash of the content

boolean

expand_relationships

Optional

Include detailed release payload for the dependencies and dependants of the release

boolean

applications_only

Optional

Include only first level releases that are applications in the catalog (exclude dependency releases)

integer

page_number

Optional

Constraints: minimum: 1 default: 1

An integer that identifies the page number for a paged response

integer

page_size

Optional

Constraints: minimum: 1 maximum: 100 default: 20

An integer that identifies the maximum page size for a paged response

Authentication

This operation uses the following authentication methods.

BearerAuth

Responses

200

Paginated list of releases of an application in an specific catalog

Returns ReleasesPage of type(s) application/json

This response body class contains all of the following: InlineReleasesPage0 , InlineReleasesPage1

"ReleasesPage Object"

400

An error related to the request

Returns ConstraintsViolationsError of type(s) application/problem+json

This response body class contains all of the following: InlineConstraintsViolationsError0

"ConstraintsViolationsError Object"

array of object

violations

Required

It represents a constraints violation error

403

The requesting user is not authorized to get the releases

Returns Error403 of type(s) application/problem+json

This response body class contains all of the following: InlineError4030

"Error403 Object"

404

The requested catalog is not found

Returns Error404 of type(s) application/problem+json

This response body class contains all of the following: InlineError4040

"Error404 Object"

500

An internal server error object

Returns Error500 of type(s) application/problem+json

This response body class contains all of the following: InlineError5000

"Error500 Object"

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json

This response body class contains all of the following: InlineError5030

"Error503 Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/v1/catalogs/{catalog_id}/releases

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Releases Operations

GET

Get Release