Skip to content

Marketplace Category Groups

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-groups/ List category groups
GET /api/marketplace-category-groups/{uuid}/ Retrieve a category group
POST /api/marketplace-category-groups/ Create a category group
PUT /api/marketplace-category-groups/{uuid}/ Update a category group
PATCH /api/marketplace-category-groups/{uuid}/ Partially update a category group
DELETE /api/marketplace-category-groups/{uuid}/ Delete a category group

List category groups

Returns a paginated list of category groups.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-groups/ \
  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_groups import marketplace_category_groups_list # (1)

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

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

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

200 -

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

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Retrieve a category group

Returns details of a specific category group.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  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_groups import marketplace_category_groups_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

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

try {
  const response = await marketplaceCategoryGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Create a category group

Creates a new category group. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-category-groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_group_request import CategoryGroupRequest # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_create # (2)

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

body_data = CategoryGroupRequest(
    title="string-value"
)
response = marketplace_category_groups_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceCategoryGroupsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "title": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
title string ✓
description string
icon string (binary)

201 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Update a category group

Updates an existing category group. Requires staff permissions.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_group_request import CategoryGroupRequest # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_update # (2)

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

body_data = CategoryGroupRequest(
    title="string-value"
)
response = marketplace_category_groups_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceCategoryGroupsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "title": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
title string ✓
description string
icon string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Partially update a category group

Partially updates an existing category group. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  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_group_request import PatchedCategoryGroupRequest # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_partial_update # (2)

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

body_data = PatchedCategoryGroupRequest()
response = marketplace_category_groups_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceCategoryGroupsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
title string
description string
icon string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Delete a category group

Deletes a category group. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  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_groups import marketplace_category_groups_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_groups_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

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

try {
  const response = await marketplaceCategoryGroupsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body