Get Requests From Application

Get Requests From Application
Get all requests of an application which belongs to a specific catalog.

Return a list of requests that match the application given which belongs to a specific catalog of the organization. The id of the organization is fetched from CSP token.

Request
URI
GET
https://api.app-catalog.vmware.com/v1/catalogs/{catalog_id}/applications/{application_id}/requests
COPY
Path Parameters
CatalogId
catalog_id
Required

A string as the identifier of a catalog

CatalogApplicationId
application_id
Required

A string as identifier of an application

Query Parameters
RequestType
request_type
Optional

It distinguish between the add and remove requests

request_type example
add
Authentication
This operation uses the following authentication methods.
Responses
200

List of requests of an application. There will be one add request and at most one remove request.

[
    {
        "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
        "name": "apache kafka",
        "description": "this has testing purpose",
        "applications": [
            {
                "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                "product": {
                    "name": "Argo CD",
                    "key": "argo-cd",
                    "description": "Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes",
                    "long_display_name": "Argo CD packaged by VMware",
                    "disclaimer": "Trademarks: This software listing is packaged by VMware. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement",
                    "category": "Developer Tools",
                    "based_on_scratch": true,
                    "latest_free": false
                },
                "branch": "2",
                "packaging_type": "HELM_CHART",
                "base_image": {
                    "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                    "name": "Debian 11",
                    "description": "Debian 11 base image",
                    "container_image": "docker.io/library/debian:11",
                    "operating_system": {
                        "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                        "name": "Centos 7",
                        "distro": "centos",
                        "version": "7"
                    },
                    "healthy": true,
                    "last_checked_at": "2023-03-03T00:59:52.762Z"
                },
                "registries": [
                    {
                        "id": "549cfa79-352c-4555-9d28-4442de551829",
                        "name": "Harbor registry for my org",
                        "url": "https://harbor.mydomain.com",
                        "healthy": true,
                        "last_checked_at": "2023-03-03T00:59:52.762Z"
                    }
                ],
                "customization": {
                    "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                    "version": "v4",
                    "artifact": {
                        "id": "127e6fbfe24a750e72930c220a8e138275656b8e5d8f48a98c3c92df2caba935",
                        "url": "/v1/catalogs/46ba3c35-fb85-44a1-8336-694b4d4f4b91/files/81a957b549848a7424eb434d3d10642dd29b6d0577757c27c09b0b9e967eb64b?filename=custom-postgresql-15-15.2.0-r5-debian-11-amd64.ova",
                        "filename": "script.sh"
                    }
                },
                "status": "CREATED",
                "created_at": "2023-03-03T00:59:52.762Z",
                "created_by": "john doe",
                "updated_at": "2023-03-03T00:59:52.762Z",
                "updated_by": "Bitnami Secure Images",
                "removed_at": "2023-03-03T00:59:52.762Z",
                "removed_by": "johndoe",
                "processing_status": {
                    "status": "COMPLETED"
                },
                "processing_status_updated_at": "2023-03-03T00:59:52.762Z",
                "latest_release": {
                    "id": "64455e6bd3c480fd58546c75",
                    "revision": "0",
                    "released_at": "2023-03-03T00:59:52.762Z",
                    "version": "2.6.7"
                },
                "latest_pipeline": {
                    "id": "94bd3a9b-ddfd-4b7e-ac56-200b8a73484d",
                    "status": "IN_PROGRESS",
                    "revision": "0",
                    "version": "2.6.7"
                },
                "deprecated_at": "2023-03-03T00:59:52.762Z",
                "unsupported_at": "2023-03-03T00:59:52.762Z",
                "trial": true,
                "fips_compliant": true,
                "stig_compliant": false,
                "containers_non_root": true,
                "end_of_life_at": "2023-03-03T00:00:00.000Z",
                "_links": {
                    "catalog": {
                        "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9"
                    },
                    "base_image": {
                        "href": "/v1/base-images/cc6c7f4d-405b-a1ca-3ac0a79418c1"
                    },
                    "requests": {
                        "href": "/v1/catalogs/cc6c7f4d-405b-a1ca-3ac0a79418c1/applications/ceb99900-f0fd-466b-96dc-1b9345fcb6ec/requests"
                    },
                    "releases": {
                        "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases?application_id=d16c7f4d-b38a-405b-a1ca-3ac0a79418c1&minimal_info=true"
                    },
                    "registries": [
                        {
                            "href": "/v1/registries/ceb99900-f0fd-466b-96dc-1b9345fcb6ec"
                        }
                    ],
                    "customization": {
                        "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/customizations/d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
                    },
                    "product": {
                        "href": "/v1/applications/product/wordpress/branch/7?packaging=CONTAINER_IMAGE&distro=photon-4"
                    },
                    "latest_release": {
                        "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases/12sdfe6bd3c480fd58549c03"
                    },
                    "latest_pipeline": {
                        "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/pipelines/beb49900-f0fd-466b-96dc-1b9345fc26aa"
                    }
                }
            }
        ],
        "request_type": "add",
        "status": "COMPLETED",
        "created_at": "2023-03-03T00:59:52.762Z",
        "created_by": "johndoe",
        "updated_at": "2023-03-03T00:59:52.762Z",
        "updated_by": "Bitnami Secure Images",
        "_links": {
            "applications": [
                {
                    "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/applications/d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
                }
            ]
        }
    }
]
array of CatalogApplicationRequest
Optional

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 
{
    "type": "https://example.com/probs/validation-error",
    "title": "Validation error",
    "status": 400,
    "detail": "There was an error validating the request",
    "violations": [
        {
            "field": "amount",
            "message": "It should be greater than zero"
        }
    ]
}
array of object
violations
Required

It represents a constraints violation error


403

The requesting user is not authorized to get the requests

Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: InlineError4030 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

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 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

500

An internal server error object

Returns Error500 of type(s) application/problem+json
This response body class contains all of the following: InlineError5000 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json
This response body class contains all of the following: InlineError5030 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/catalogs/{catalog_id}/applications/{application_id}/requests
On This Page
Requests Operations
GET
Get Application Requests
POST
Create Application Request
GET
Get Application Request
GET
Get Requests From Application