Skip to content

Project Types

Simple model for categorizing projects. Provides project type classification with name, description, and UUID identification. Used to categorize projects into different types for organizational purposes.

Operations Summary

Method Endpoint Description
GET /api/project-types/ List project types
GET /api/project-types/{uuid}/ Retrieve project type details

List project types

Retrieve a list of available project types.

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-types/ \
  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.project_types import project_types_list # (1)

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

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

try {
  const response = await projectTypesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string
name_exact string
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)
url string (uri)
name string
description string

Retrieve project type details

Fetch details of a specific project type by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-types/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.project_types import project_types_retrieve # (1)

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

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

try {
  const response = await projectTypesRetrieve({
  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)
url string (uri)
name string
description string