Get Branch Applications

Get Branch Applications

Provides all the applications for the specified branch, regardless of the status, with optional filters.

Request
URI
GET
https://{api_host}/v1/applications/product/{product_id_or_key}/branch/{branch_id_or_key}
COPY
Path Parameters
product_id_or_key
Required

A string with either UUID format as the identifier of the requested product or its key.

string
branch_id_or_key
Required
Constraints: maxLength: 100

A string with either UUID format as the identifier of the requested branch or its key

Query Parameters
packaging
Optional

Packaging type to filter by

string
distro
Optional
Constraints: maxLength: 100

Distro ID or key to filter by

string
architecture
Optional
Constraints: maxLength: 30

Processor architecture to filter by

boolean
only_built_versions
Optional
Constraints: default: true

Parameter to query only for the applications that actually have a built version. If parameter is set to "false" then all related platforms without built version will appear under the same application, with empty version.

status
Optional

Status of the item to filter by

boolean
only_supported
Optional
Constraints: default: false

Parameter to query only for supported items. A supported item is considered to have one of the following statuses: (ACTIVE,SCHEDULED_DEPRECATION,DEPRECATION_GRACE_PERIOD)

boolean
only_eligible
Optional
Constraints: default: false

Parameter to query only for eligible items. An eligible item is considered to have one of the following statuses: (ACTIVE,SCHEDULED_DEPRECATION)


Authentication
This operation uses the following authentication methods.
Responses
200

A list containing the applications

Returns ApplicationBranch of type(s) application/json
This response body class contains all of the following: InlineApplicationBranch0 , InlineApplicationBranch1
"ApplicationBranch Object"

400

An error related to the query or path parameters

Returns ConstraintsViolationsError of type(s) application/json
This response body class contains all of the following: InlineConstraintsViolationsError0
"ConstraintsViolationsError Object"
array of object
violations
Required

It represents a constraints violation error


500

An internal server error object

Returns Error of type(s) application/json
"Error Object"
string As uri As uri
type
Required

A URI reference that identifies the problem type

When dereferenced, it provide human-readable documentation for the problem type using HTML

string
title
Required

A short, human-readable summary of the problem type

integer
status
Optional

The HTTP status code generated by the origin server for this occurrence of the problem

string
detail
Optional

A human-readable explanation specific to this occurrence of the problem

string As uri-reference As uri-reference
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/applications/product/{product_id_or_key}/branch/{branch_id_or_key}