Get Applications

Get Applications

Return a paginated list of applications in a specific catalog for an organization ordered by product name. The id of the organization is fetched from CSP token

Request
URI
GET
https://{api_host}/v1/catalogs/{catalog_id}/applications
COPY
Path Parameters
CatalogId
catalog_id
Required

A string as the identifier of a catalog

Query Parameters
PackagingType
packaging_type
Optional

Packaging type of an application

of BaseImageId array
base_image_ids
Optional

A list of strings as the identifier of a base images

base_image_ids example 
a8de6e15-a21f-45f1-9155-341ab027e79e,c105f08b-db43-4c05-b6a5-2195fefd3ce7
string
product_name
Optional

Return applications that matches any part of the name

product_name example 
apache
string
product_key
Optional

The key name of the product

string
product_category
Optional

The category which the product belongs

string of array
statuses
Optional

Return objects based on status flag (PENDING, REMOVED, DEPRECATED, RELEASED, ARCHIVED)

statuses example 
RELEASED,PENDING
string
order_field
Optional
Constraints: default: PRODUCT_NAME

Name of the field to order the applications: PRODUCT_NAME (default), BASE_IMAGE_NAME, LATEST_RELEASE_VERSION, STATUS, LATEST_RELEASE_RELEASED_AT, CREATED_AT, CREATED_BY, DELETED_AT, DELETED_BY

order_field example 
BASE_IMAGE_NAME
string
order_direction
Optional
Constraints: default: ASC

Order to sort by the selected field: ASC (default) or DESC

integer
page
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.
Responses
200

Paginated list of applications in an specific catalog

Returns CatalogApplicationsPage of type(s) application/json
This response body class contains all of the following: InlineCatalogApplicationsPage0 , InlineCatalogApplicationsPage1 
"CatalogApplicationsPage 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 applications

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 -H 'Authorization: <value>' https://{api_host}/v1/catalogs/{catalog_id}/applications
On This Page
Applications Operations
GET
Get Applications
GET
Get Application