Skip to content

Maintenance Announcements Template

Operations Summary

Method Endpoint Description
GET /api/maintenance-announcements-template/ List Maintenance Announcements Template
GET /api/maintenance-announcements-template/{uuid}/ Retrieve
POST /api/maintenance-announcements-template/ Create
PUT /api/maintenance-announcements-template/{uuid}/ Update
PATCH /api/maintenance-announcements-template/{uuid}/ Partial Update
DELETE /api/maintenance-announcements-template/{uuid}/ Delete

List Maintenance Announcements Template

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcements-template/ \
  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.maintenance_announcements_template import maintenance_announcements_template_list # (1)

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

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

try {
  const response = await maintenanceAnnouncementsTemplateList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
maintenance_type integer
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
service_provider_uuid string (uuid)

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
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcements-template/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.maintenance_announcements_template import maintenance_announcements_template_retrieve # (1)

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

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

try {
  const response = await maintenanceAnnouncementsTemplateRetrieve({
  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
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/maintenance-announcements-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-maintenance-announcements-template" \
  service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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.maintenance_announcement_template_request import MaintenanceAnnouncementTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_create # (2)

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

body_data = MaintenanceAnnouncementTemplateRequest(
    name="my-awesome-maintenance-announcements-template",
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcements_template_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await maintenanceAnnouncementsTemplateCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-maintenance-announcements-template",
    "service_provider": "https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) ✓ Service provider announcing the maintenance

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/maintenance-announcements-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-maintenance-announcements-template" \
  service_provider="https://api.example.com/api/service-provider/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.maintenance_announcement_template_request import MaintenanceAnnouncementTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_update # (2)

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

body_data = MaintenanceAnnouncementTemplateRequest(
    name="my-awesome-maintenance-announcements-template",
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcements_template_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await maintenanceAnnouncementsTemplateUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-maintenance-announcements-template",
    "service_provider": "https://api.example.com/api/service-provider/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
name string ✓
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) ✓ Service provider announcing the maintenance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/maintenance-announcements-template/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_maintenance_announcement_template_request import PatchedMaintenanceAnnouncementTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_partial_update # (2)

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

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

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

try {
  const response = await maintenanceAnnouncementsTemplatePartialUpdate({
  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
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/maintenance-announcements-template/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.maintenance_announcements_template import maintenance_announcements_template_destroy # (1)

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

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

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