Skip to content

Checklists Admin Categories

Operations Summary

Method Endpoint Description
GET /api/checklists-admin-categories/ List Checklists Admin Categories
GET /api/checklists-admin-categories/{uuid}/ Retrieve
POST /api/checklists-admin-categories/ Create
PUT /api/checklists-admin-categories/{uuid}/ Update
PATCH /api/checklists-admin-categories/{uuid}/ Partial Update
DELETE /api/checklists-admin-categories/{uuid}/ Delete

List Checklists Admin Categories

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-categories/ \
  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.checklists_admin_categories import checklists_admin_categories_list # (1)

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

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

try {
  const response = await checklistsAdminCategoriesList({
  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
uuid string (uuid)
icon string (uri)
url string (uri)
name string
description string
checklists_count integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-categories/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.checklists_admin_categories import checklists_admin_categories_retrieve # (1)

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

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

try {
  const response = await checklistsAdminCategoriesRetrieve({
  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
uuid string (uuid)
icon string (uri)
url string (uri)
name string
description string
checklists_count integer

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/checklists-admin-categories/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-checklists-admin-category"

 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.checklist_category_request import ChecklistCategoryRequest # (1)
from waldur_api_client.api.checklists_admin_categories import checklists_admin_categories_create # (2)

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

body_data = ChecklistCategoryRequest(
    name="my-awesome-checklists-admin-category"
)
response = checklists_admin_categories_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await checklistsAdminCategoriesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-checklists-admin-category"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
icon string (binary)
name string ✓
description string

201 -

Field Type
uuid string (uuid)
icon string (uri)
url string (uri)
name string
description string
checklists_count integer

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/checklists-admin-categories/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-checklists-admin-category"

 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.checklist_category_request import ChecklistCategoryRequest # (1)
from waldur_api_client.api.checklists_admin_categories import checklists_admin_categories_update # (2)

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

body_data = ChecklistCategoryRequest(
    name="my-awesome-checklists-admin-category"
)
response = checklists_admin_categories_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

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

200 -

Field Type
uuid string (uuid)
icon string (uri)
url string (uri)
name string
description string
checklists_count integer

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/checklists-admin-categories/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_checklist_category_request import PatchedChecklistCategoryRequest # (1)
from waldur_api_client.api.checklists_admin_categories import checklists_admin_categories_partial_update # (2)

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

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

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

try {
  const response = await checklistsAdminCategoriesPartialUpdate({
  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
icon string (binary)
name string
description string

200 -

Field Type
uuid string (uuid)
icon string (uri)
url string (uri)
name string
description string
checklists_count integer

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/checklists-admin-categories/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.checklists_admin_categories import checklists_admin_categories_destroy # (1)

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

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

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