Get Customizations

Get Customizations

Return a paginated list of customizations in a catalog that match the query params searching ordered by creation date descending. The id of the organization is fetched from CSP token.

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

A string as the identifier of a catalog

Query Parameters
string
product_key
Optional

The key name of the product

BaseImageId
base_image_id
Optional

A string as the identifier of a base image

string
branch
Optional

The branch of the product

boolean
active
Optional
Constraints: default: false

It filters the deleted customizations.

active example 
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

Authentication
This operation uses the following authentication methods.
Responses
200

Paginated list of customizations

Returns CustomizationDetailedPage of type(s) application/json
This response body class contains all of the following: InlineCustomizationDetailedPage0 , InlineCustomizationDetailedPage1 
"CustomizationDetailedPage Object"

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 customizations

Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: InlineError4030 
"Error403 Object"

404

The 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}/customizations
On This Page
Customizations Operations
GET
Get Customizations
POST
Create Customization
GET
Get Customization
DELETE
Delete Customization
PATCH
Update Customization