Get Catalogs
Return a paginated list of catalogs in an organization. The id of the organization is fetched from CSP token
Request
URI
GET
https://{api_host}/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)
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
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",
"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
"ConstraintsViolationsError Object"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
"Error403 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