Get Catalogs

Get Catalogs
Get catalogs in an organization

Return a paginated list of catalogs in an organization. The id of the organization is fetched from CSP token

Request
URI
GET
https://api.app-catalog.vmware.com/v1/catalogs
COPY
Query Parameters
boolean
shared
Optional

Objects are private to the organization in the request (shared=false) or shared between organizations (shared=true)

boolean
owned
Optional

Object is owned by the organization in the request (owned=true)

string
order_field
Optional
Constraints: default: CREATED_AT

Name of the field to order the catalogs: CREATED_AT (default), NAME, NAMESPACE, ORGANIZATION_NAME, UPDATED_AT

order_field example
CREATED_AT
string
order_direction
Optional
Constraints: default: DESC

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

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 catalogs in an organization

Returns CatalogsPage of type(s) application/json
This response body class contains all of the following: InlineCatalogsPage0 , InlineCatalogsPage1 
{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
            "name": "DefaultCatalog",
            "created_at": "2017-07-21T17:32:28.000Z",
            "updated_at": "2017-07-21T17:32:28.000Z",
            "removed_at": "2017-07-21T17:32:28.000Z",
            "shared": false,
            "owned": true,
            "_links": {
                "applications": {
                    "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/applications"
                },
                "customizations": {
                    "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/customizations"
                }
            }
        }
    ]
}

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 catalogs

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 -H 'Authorization: <value>' https://{api_host}/v1/catalogs
On This Page
Catalogs Operations
GET
Get Catalogs
GET
Get Catalog
GET
Get File