Create Application Request

Create a new request to add or delete applications in a catalog

Create a new request for adding or removing applications to/from an organization's catalog

Request

URI

POST

https://api.app-catalog.vmware.com/v1/catalogs/{catalog_id}/application-requests

COPY

Path Parameters

CatalogId

catalog_id

Required

A string as the identifier of a catalog

Request Body

CatalogApplicationRequestPostBody of type(s) application/json

Required

OneOf

This class requires at least one of the following:

InlineCatalogApplicationRequestPostBody0

InlineCatalogApplicationRequestPostBody1

{
    "name": "My application creation request",
    "description": "Application creation request with some apps",
    "application_offering_ids": [
        "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
    ],
    "base_image_id": "549cfa79-352c-4555-9d28-4442de551829",
    "registry_ids": [
        "549cfa79-352c-4555-9d28-4442de551829"
    ],
    "kind": "string"
}

string

kind

Optional

The type of application request

Possible values are : CREATION, DELETION,

Authentication

This operation uses the following authentication methods.

BearerAuth

Responses

201

The application request has been created

Operation doesn't return any data structure

Response Headers

string

Location

Url to request the application request that has been created.

400

An error related to the application 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 create a new application request

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"
}

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/catalogs/{catalog_id}/application-requests

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Requests Operations

GET

Get Application Requests