Skip to content

Service Settings

Operations Summary

Method Endpoint Description
GET /api/service-settings/ List Service Settings
GET /api/service-settings/{uuid}/ Retrieve

List Service Settings

1
2
3
4
http \
  GET \
  https://api.example.com/api/service-settings/ \
  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.service_settings import service_settings_list # (1)

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

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

try {
  const response = await serviceSettingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uuid)
customer_uuid string (uuid)
field array
name string
name_exact string
o string Which field to use when ordering the results.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope_uuid string Scope UUID
shared boolean
state array
type string

200 -

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

Field Type Description
url string (uri)
uuid string (uuid)
name string
type string
state any
error_message string
shared boolean Anybody can use it
customer string (uri)
customer_name string
customer_native_name string
terms_of_services string (uri)
scope string
scope_uuid string (uuid)
options object (free-form)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/service-settings/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.service_settings import service_settings_retrieve # (1)

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

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

try {
  const response = await serviceSettingsRetrieve({
  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 Description
url string (uri)
uuid string (uuid)
name string
type string
state any
error_message string
shared boolean Anybody can use it
customer string (uri)
customer_name string
customer_native_name string
terms_of_services string (uri)
scope string
scope_uuid string (uuid)
options object (free-form)