Skip to content

Proposal Requested Resources

Operations Summary

Method Endpoint Description
GET /api/proposal-requested-resources/ List Proposal Requested Resources
GET /api/proposal-requested-resources/{uuid}/ Retrieve

List Proposal Requested Resources

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-requested-resources/ \
  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.proposal_states import ProposalStates # (1)
from waldur_api_client.models.user_requested_resource_o_enum import UserRequestedResourceOEnum # (2)
from waldur_api_client.api.proposal_requested_resources import proposal_requested_resources_list # (3)

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

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

try {
  const response = await proposalRequestedResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time)
o array Ordering
offering string (uri) Offering
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal string (uri) Proposal
proposal_state array Proposal state
proposal_uuid string (uuid)
query string Search by offering, proposal, call or resource name
resource string (uri) Resource
resource_uuid string (uuid)

200 -

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

Field Type Description
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes object (free-form)
limits object (free-form)
purchase_order_reference string
attachment string (uri)
purchase_order_required boolean
has_purchase_order boolean Either half satisfies the requirement. Some providers want the document, others only need the reference from the customer's finance system; demanding both would block the second group for no gain.
description string
created_by string (uri)
created_by_name string
proposal_name string
proposal string (uri)

Retrieve

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

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

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

try {
  const response = await proposalRequestedResourcesRetrieve({
  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
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes object (free-form)
limits object (free-form)
purchase_order_reference string
attachment string (uri)
purchase_order_required boolean
has_purchase_order boolean Either half satisfies the requirement. Some providers want the document, others only need the reference from the customer's finance system; demanding both would block the second group for no gain.
description string
created_by string (uri)
created_by_name string
proposal_name string
proposal string (uri)