Skip to content

Proposal Requested Offerings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/proposal-requested-offerings/ List Proposal Requested Offerings
GET /api/proposal-requested-offerings/{uuid}/ Retrieve
Other Actions
POST /api/proposal-requested-offerings/{uuid}/accept/ Accept a requested offering
POST /api/proposal-requested-offerings/{uuid}/cancel/ Cancel a requested offering

Core CRUD

List Proposal Requested Offerings

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-requested-offerings/ \
  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.models.provider_requested_offering_o_enum import ProviderRequestedOfferingOEnum # (1)
from waldur_api_client.models.requested_offering_states import RequestedOfferingStates # (2)
from waldur_api_client.api.proposal_requested_offerings import proposal_requested_offerings_list # (3)

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

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

try {
  const response = await proposalRequestedOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call string (uri) Call
call_uuid string (uuid)
o array Ordering
offering string (uri) Offering
offering_uuid string (uuid)
organization_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
provider_uuid string (uuid) Provider
state array

200 -

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

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.offering_uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
components.min_renewal_duration integer Minimum number of months allowed for a renewal.
components.max_renewal_duration integer Maximum number of months allowed for a renewal.
components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
created string (date-time)
url string (uri)
call_name string
call string (uri)
description string
created_by_name string
created_by_email string (email)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-requested-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.proposal_requested_offerings import proposal_requested_offerings_retrieve # (1)

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

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

try {
  const response = await proposalRequestedOfferingsRetrieve({
  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)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.offering_uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
components.min_renewal_duration integer Minimum number of months allowed for a renewal.
components.max_renewal_duration integer Maximum number of months allowed for a renewal.
components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
created string (date-time)
url string (uri)
call_name string
call string (uri)
description string
created_by_name string
created_by_email string (email)

Other Actions

Accept a requested offering

Accept a requested offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-requested-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  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.proposal_requested_offerings import proposal_requested_offerings_accept # (1)

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

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

try {
  const response = await proposalRequestedOfferingsAccept({
  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 - No response body

Cancel a requested offering

Cancel a requested offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-requested-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel/ \
  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.proposal_requested_offerings import proposal_requested_offerings_cancel # (1)

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

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

try {
  const response = await proposalRequestedOfferingsCancel({
  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 - No response body