Skip to content

Admin Announcements

Operations Summary

Method Endpoint Description
GET /api/admin-announcements/ List Admin Announcements
GET /api/admin-announcements/{uuid}/ Retrieve
POST /api/admin-announcements/ Create
PUT /api/admin-announcements/{uuid}/ Update
PATCH /api/admin-announcements/{uuid}/ Partial Update
DELETE /api/admin-announcements/{uuid}/ Delete

List Admin Announcements

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin-announcements/ \
  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.admin_announcements import admin_announcements_list # (1)

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

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

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

200 -

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

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin-announcements/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.admin_announcements import admin_announcements_retrieve # (1)

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

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

try {
  const response = await adminAnnouncementsRetrieve({
  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
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin-announcements/ \
  Authorization:"Token YOUR_API_TOKEN" \
  active_from="2023-10-01T12:00:00Z" \
  active_to="2023-10-01T12:00:00Z"

 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.admin_announcement_request import AdminAnnouncementRequest # (1)
from waldur_api_client.api.admin_announcements import admin_announcements_create # (2)

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

body_data = AdminAnnouncementRequest(
    active_from="2023-10-01T12:00:00Z",
    active_to="2023-10-01T12:00:00Z"
)
response = admin_announcements_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await adminAnnouncementsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "active_from": "2023-10-01T12:00:00Z",
    "active_to": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
description string
active_from string (date-time) ✓
active_to string (date-time) ✓
type string

201 -

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/admin-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  active_from="2023-10-01T12:00:00Z" \
  active_to="2023-10-01T12:00:00Z"

 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.admin_announcement_request import AdminAnnouncementRequest # (1)
from waldur_api_client.api.admin_announcements import admin_announcements_update # (2)

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

body_data = AdminAnnouncementRequest(
    active_from="2023-10-01T12:00:00Z",
    active_to="2023-10-01T12:00:00Z"
)
response = admin_announcements_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await adminAnnouncementsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "active_from": "2023-10-01T12:00:00Z",
    "active_to": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
active_from string (date-time) ✓
active_to string (date-time) ✓
type string

200 -

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/admin-announcements/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_admin_announcement_request import PatchedAdminAnnouncementRequest # (1)
from waldur_api_client.api.admin_announcements import admin_announcements_partial_update # (2)

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

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

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

try {
  const response = await adminAnnouncementsPartialUpdate({
  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 string
active_from string (date-time)
active_to string (date-time)
type string

200 -

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/admin-announcements/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.admin_announcements import admin_announcements_destroy # (1)

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

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

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