Skip to content

Notification Messages Templates

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/notification-messages-templates/ List Notification Messages Templates
GET /api/notification-messages-templates/{uuid}/ Retrieve
POST /api/notification-messages-templates/ Create
PUT /api/notification-messages-templates/{uuid}/ Update
PATCH /api/notification-messages-templates/{uuid}/ Partial Update
DELETE /api/notification-messages-templates/{uuid}/ Delete
Other Actions
POST /api/notification-messages-templates/{uuid}/override/ Override notification template content

Core CRUD

List Notification Messages Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/notification-messages-templates/ \
  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.notification_messages_templates import notification_messages_templates_list # (1)

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

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

try {
  const response = await notificationMessagesTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
is_overridden boolean
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.
path string
path_exact string

200 -

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

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/notification-messages-templates/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.notification_messages_templates import notification_messages_templates_retrieve # (1)

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

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

try {
  const response = await notificationMessagesTemplatesRetrieve({
  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)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/notification-messages-templates/ \
  Authorization:"Token YOUR_API_TOKEN" \
  path="string-value" \
  name="my-awesome-notification-messages-template"

 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.notification_template_detail_serializers_request import NotificationTemplateDetailSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_create # (2)

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

body_data = NotificationTemplateDetailSerializersRequest(
    path="string-value",
    name="my-awesome-notification-messages-template"
)
response = notification_messages_templates_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await notificationMessagesTemplatesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "path": "string-value",
    "name": "my-awesome-notification-messages-template"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
path string ✓ Example: 'flatpages/default.html'
name string ✓

201 -

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/notification-messages-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  path="string-value" \
  name="my-awesome-notification-messages-template"

 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.notification_template_detail_serializers_request import NotificationTemplateDetailSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_update # (2)

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

body_data = NotificationTemplateDetailSerializersRequest(
    path="string-value",
    name="my-awesome-notification-messages-template"
)
response = notification_messages_templates_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await notificationMessagesTemplatesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "path": "string-value",
    "name": "my-awesome-notification-messages-template"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
path string ✓ Example: 'flatpages/default.html'
name string ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/notification-messages-templates/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_notification_template_detail_serializers_request import PatchedNotificationTemplateDetailSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_partial_update # (2)

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

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

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

try {
  const response = await notificationMessagesTemplatesPartialUpdate({
  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
path string Example: 'flatpages/default.html'
name string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/notification-messages-templates/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.notification_messages_templates import notification_messages_templates_destroy # (1)

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

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

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

Other Actions

Override notification template content

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/notification-messages-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/override/ \
  Authorization:"Token YOUR_API_TOKEN" \
  content="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.notification_template_update_serializers_request import NotificationTemplateUpdateSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_override # (2)

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

body_data = NotificationTemplateUpdateSerializersRequest(
    content="string-value"
)
response = notification_messages_templates_override.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

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

200 - No response body