Get Release Failures

Get Release Failures

Return the failures related with a release that match the search criteria. The id of the organization is fetched from CSP token.

Request
URI
GET
https://{api_host}/v1/catalogs/{catalog_id}/release-failures
COPY
Path Parameters
catalog_id
Required

A string as the identifier of a catalog

Query Parameters
string
product_key
Required

The key name of the product

string
branch
Required

The branch of the product

packaging_type
Required

Packaging type of an application

base_image_id
Required

A string as the identifier of a base image


Authentication
This operation uses the following authentication methods.
Responses
200

Failure related with the release that match the query parameters

Returns ReleaseFailure of type(s) application/json
"ReleaseFailure Object"
string
description
Required

Description of the error

string
source_url
Optional

Endpoint which will return the s3 signed url to download the source code

string As date-time As date-time
error_date
Optional

The date-time which the attempt of release failed

string
cause
Optional

Cause of the release failure (UNKNOWN, CUSTOMIZATION_BUILD_ERROR, TEST_ERROR, BUILD_ERROR)


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 failures

Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: InlineError4030
"Error403 Object"

404

The catalog is not found for the organization or there is no failure in the release process

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 -H 'Authorization: <value>' https://{api_host}/v1/catalogs/{catalog_id}/release-failures?product_key=value&branch=value&packaging_type=value&base_image_id=v