Get Catalog

Get Catalog

Return a specific catalog in an organization. The id of the organization is fetched from CSP token

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

A string as the identifier of a catalog


Authentication
This operation uses the following authentication methods.
Responses
200

Details of the catalog

Returns Catalog of type(s) application/json
"Catalog Object"
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

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