Skip to content

Marketplace Category Columns

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-columns/ List Marketplace Category Columns
GET /api/marketplace-category-columns/{uuid}/ Retrieve
POST /api/marketplace-category-columns/ Create
PUT /api/marketplace-category-columns/{uuid}/ Update
PATCH /api/marketplace-category-columns/{uuid}/ Partial Update
DELETE /api/marketplace-category-columns/{uuid}/ Delete

List Marketplace Category Columns

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

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

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

try {
  const response = await marketplaceCategoryColumnsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
category_uuid string (uuid)
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 Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Retrieve

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

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

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

try {
  const response = await marketplaceCategoryColumnsRetrieve({
  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) ✓

200 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-category-columns/ \
  Authorization:"Token YOUR_API_TOKEN" \
  index=123 \
  title="string-value" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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_column_request import CategoryColumnRequest # (1)
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_create # (2)

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

body_data = CategoryColumnRequest(
    index=123,
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_category_columns_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceCategoryColumnsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "index": 123,
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
index integer ✓ Index allows to reorder columns.
title string ✓ Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri) ✓

201 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Update

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

 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_column_request import CategoryColumnRequest # (1)
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_update # (2)

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

body_data = CategoryColumnRequest(
    index=123,
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_category_columns_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceCategoryColumnsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "index": 123,
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
index integer ✓ Index allows to reorder columns.
title string ✓ Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri) ✓

200 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-category-columns/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_column_request import PatchedCategoryColumnRequest # (1)
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_partial_update # (2)

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

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

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

try {
  const response = await marketplaceCategoryColumnsPartialUpdate({
  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 Description
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

200 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-category-columns/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_columns import marketplace_category_columns_destroy # (1)

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

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

try {
  const response = await marketplaceCategoryColumnsDestroy({
  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