Skip to content

Maintenance Announcement Offerings

Operations Summary

Method Endpoint Description
GET /api/maintenance-announcement-offerings/ List affected offerings for maintenance
GET /api/maintenance-announcement-offerings/{uuid}/ Retrieve an affected offering link
POST /api/maintenance-announcement-offerings/ Link an offering to a maintenance announcement
PUT /api/maintenance-announcement-offerings/{uuid}/ Update an affected offering link
PATCH /api/maintenance-announcement-offerings/{uuid}/ Partially update an affected offering link
DELETE /api/maintenance-announcement-offerings/{uuid}/ Unlink an offering from a maintenance announcement

List affected offerings for maintenance

Returns a paginated list of offerings affected by maintenance announcements.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcement-offerings/ \
  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_announcement_offerings import maintenance_announcement_offerings_list # (1)

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

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

try {
  const response = await maintenanceAnnouncementOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
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 Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Returns the details of a specific link between a maintenance announcement and an offering, including the impact level and description.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcement-offerings/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_announcement_offerings import maintenance_announcement_offerings_retrieve # (1)

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

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

try {
  const response = await maintenanceAnnouncementOfferingsRetrieve({
  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)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Creates a new association between an offering and a maintenance announcement, specifying the expected impact.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/maintenance-announcement-offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offering="https://api.example.com/api/offering/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_offering_request import MaintenanceAnnouncementOfferingRequest # (1)
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_create # (2)

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

body_data = MaintenanceAnnouncementOfferingRequest(
    maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcement_offerings_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await maintenanceAnnouncementOfferingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "maintenance": "https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
maintenance string (uri) ✓
offering string (uri) ✓
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

201 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Updates the impact level or description for an offering linked to a maintenance announcement.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/maintenance-announcement-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offering="https://api.example.com/api/offering/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_offering_request import MaintenanceAnnouncementOfferingRequest # (1)
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_update # (2)

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

body_data = MaintenanceAnnouncementOfferingRequest(
    maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcement_offerings_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await maintenanceAnnouncementOfferingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "maintenance": "https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offering": "https://api.example.com/api/offering/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
maintenance string (uri) ✓
offering string (uri) ✓
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Partially updates the impact level or description for an offering linked to a maintenance announcement.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/maintenance-announcement-offerings/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_offering_request import PatchedMaintenanceAnnouncementOfferingRequest # (1)
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_partial_update # (2)

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

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

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

try {
  const response = await maintenanceAnnouncementOfferingsPartialUpdate({
  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
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Removes the association between an offering and a maintenance announcement.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/maintenance-announcement-offerings/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_announcement_offerings import maintenance_announcement_offerings_destroy # (1)

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

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

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