Get Catalog
Get a catalog in an organization
Return a specific catalog in an organization. The id of the organization is fetched from CSP token
Request
URI
GET
https://api.app-catalog.vmware.com/v1/catalogs/{catalog_id}
COPY
Path Parameters
Responses
200
Details of the catalog
Returns
Catalog
of type(s)
application/json
{
"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"
}
}
}
string
id
Required
Identifier of the catalog
string
name
Required
Name of the catalog
string As date-time
As date-time
created_at
Optional
Date when the catalog was registered
string As date-time
As date-time
updated_at
Optional
Last date when the catalog was updated
string As date-time
As date-time
removed_at
Optional
Date when the catalog was removed
boolean
shared
Required
Catalog is (or can be) shared with different organizations
boolean
owned
Required
Organization owns the catalog
object
_links
Optional
Section to include hyperlinks based on Hypertext Application Language
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 catalog
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}