Skip to content

Marketplace Category Components

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-components/ List category components
GET /api/marketplace-category-components/{id}/ Retrieve a category component
POST /api/marketplace-category-components/ Create a category component
PUT /api/marketplace-category-components/{id}/ Update a category component
PATCH /api/marketplace-category-components/{id}/ Partially update a category component
DELETE /api/marketplace-category-components/{id}/ Delete a category component

List category components

Returns a paginated list of all components defined at the category level. These act as templates for components in offerings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-components/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_components_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_category_components_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoryComponentsList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Retrieve a category component

Returns the details of a specific category component, identified by its ID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_components_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_category_components_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.

200 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Create a category component

Creates a new component for a category. Requires staff permissions.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-category-components/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  name="my-awesome-marketplace-category-component" \
  category:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_components_request import CategoryComponentsRequest # (1)
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryComponentsRequest(
    type="string-value",
    name="my-awesome-marketplace-category-component",
    category={}
)
response = marketplace_category_components_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryComponentsRequest
  2. API Source: marketplace_category_components_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceCategoryComponentsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "type": "string-value",
    "name": "my-awesome-marketplace-category-component",
    "category": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
type string ✓ Unique internal name of the measured unit, for example floating_ip.
name string ✓ Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object ✓
category.title string ✓

201 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Update a category component

Updates an existing category component. Requires staff permissions.

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  name="my-awesome-marketplace-category-component" \
  category:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_components_request import CategoryComponentsRequest # (1)
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryComponentsRequest(
    type="string-value",
    name="my-awesome-marketplace-category-component",
    category={}
)
response = marketplace_category_components_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryComponentsRequest
  2. API Source: marketplace_category_components_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceCategoryComponentsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  },
  body: {
    "type": "string-value",
    "name": "my-awesome-marketplace-category-component",
    "category": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.
Field Type Required Description
type string ✓ Unique internal name of the measured unit, for example floating_ip.
name string ✓ Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object ✓
category.title string ✓

200 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Partially update a category component

Partially updates an existing category component. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_category_components_request import PatchedCategoryComponentsRequest # (1)
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCategoryComponentsRequest()
response = marketplace_category_components_partial_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCategoryComponentsRequest
  2. API Source: marketplace_category_components_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.
Field Type Required Description
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.title string ✓

200 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Delete a category component

Deletes a category component. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_components_destroy.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_category_components_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.

204 - No response body