Skip to content

Proposal Protected Calls

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/proposal-protected-calls/ List Proposal Protected Calls
GET /api/proposal-protected-calls/{uuid}/ Retrieve
POST /api/proposal-protected-calls/ Create
PUT /api/proposal-protected-calls/{uuid}/ Update
PATCH /api/proposal-protected-calls/{uuid}/ Partial Update
DELETE /api/proposal-protected-calls/{uuid}/ Delete
Permissions & Users
GET /api/proposal-protected-calls/{uuid}/list_users/ List users
POST /api/proposal-protected-calls/{uuid}/add_user/ Add user
POST /api/proposal-protected-calls/{uuid}/delete_user/ Delete user
POST /api/proposal-protected-calls/{uuid}/update_user/ Update user
Other Actions
GET /api/proposal-protected-calls/{uuid}/compliance_overview/ Compliance overview
GET /api/proposal-protected-calls/{uuid}/offerings/ List offerings for a call
GET /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Retrieve
GET /api/proposal-protected-calls/{uuid}/proposals/{proposal_uuid}/compliance-answers/ Get detailed compliance answers for a specific proposal (call managers only)
GET /api/proposal-protected-calls/{uuid}/resource_templates/ List resource templates for a call
GET /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Retrieve
GET /api/proposal-protected-calls/{uuid}/rounds/ List rounds for a call
GET /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Retrieve
POST /api/proposal-protected-calls/{uuid}/activate/ Activate a call
POST /api/proposal-protected-calls/{uuid}/archive/ Archive a call
POST /api/proposal-protected-calls/{uuid}/attach_documents/ Attach documents to call
POST /api/proposal-protected-calls/{uuid}/detach_documents/ Detach documents from call
POST /api/proposal-protected-calls/{uuid}/offerings/ Create offering for a call
POST /api/proposal-protected-calls/{uuid}/resource_templates/ Create resource template for a call
POST /api/proposal-protected-calls/{uuid}/review_proposal_compliance/ Mark proposal compliance as reviewed by call manager
POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/ Close
POST /api/proposal-protected-calls/{uuid}/rounds/ Create a round for a call
PUT /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Update
PUT /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Update
PUT /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Update
PATCH /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Partial Update
PATCH /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Partial Update
PATCH /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Partial Update
DELETE /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Delete
DELETE /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Delete
DELETE /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Delete

Core CRUD

List Proposal Protected Calls

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/ \
  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.proposal_protected_calls import proposal_protected_calls_list # (1)

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

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

try {
  const response = await proposalProtectedCallsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string
customer_keyword string
customer_uuid string (uuid)
field array
has_active_round boolean
name string
o array Ordering

offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

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)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/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_protected_calls import proposal_protected_calls_retrieve # (1)

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

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

try {
  const response = await proposalProtectedCallsRetrieve({
  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 Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  manager="https://api.example.com/api/manager/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.protected_call_request import ProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_create # (2)

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

body_data = ProtectedCallRequest(
    name="my-awesome-proposal-protected-call",
    manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-proposal-protected-call",
    "manager": "https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
slug string
name string
description string
manager string (uri)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  manager="https://api.example.com/api/manager/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.protected_call_request import ProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update # (2)

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

body_data = ProtectedCallRequest(
    name="my-awesome-proposal-protected-call",
    manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "manager": "https://api.example.com/api/manager/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
slug string
name string
description string
manager string (uri)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/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_protected_call_request import PatchedProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_partial_update # (2)

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

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

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

try {
  const response = await proposalProtectedCallsPartialUpdate({
  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
slug string
name string
description string
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/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_protected_calls import proposal_protected_calls_destroy # (1)

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

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

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


Permissions & Users

List users

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_list_users_list # (1)

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

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

try {
  const response = await proposalProtectedCallsListUsersList({
  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 Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

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

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Add user

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="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.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_add_user # (2)

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

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid)
Field Type Required
role string
user string (uuid)
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 -

Field Type Description
non_field_errors array of strings

Delete user

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="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.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_delete_user # (2)

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

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid)
Field Type Required
role string
user string (uuid)
expiration_time string (date-time)

200 - No response body


Update user

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="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.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update_user # (2)

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

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid)
Field Type Required
role string
user string (uuid)
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Other Actions

Compliance overview

Get compliance overview for call manager showing all proposals and their compliance status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compliance_overview/ \
  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_protected_calls import proposal_protected_calls_compliance_overview_retrieve # (1)

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

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

try {
  const response = await proposalProtectedCallsComplianceOverviewRetrieve({
  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
checklist object (free-form)
proposals array of anys

List offerings for a call

List offerings for a call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offerings/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_list # (1)

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

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

try {
  const response = await proposalProtectedCallsOfferingsList({
  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 Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state string Filter by state

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.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
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/string-value/offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_retrieve # (1)

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

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

try {
  const response = await proposalProtectedCallsOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string

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.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
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Get detailed compliance answers for a specific proposal (call managers only)

Get detailed compliance answers for a specific proposal (call managers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compliance-answers/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_proposals_compliance_answers_list # (1)

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

for item in response:
    print(item)
  1. API Source: proposal_protected_calls_proposals_compliance_answers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsProposalsComplianceAnswersList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsProposalsComplianceAnswersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
proposal_uuid string UUID of the proposal
uuid string (uuid)
Name Type Description
customer string
customer_keyword string
customer_uuid string (uuid)
has_active_round boolean
name string
o array Ordering

offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

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

Field Type Description
uuid string (uuid)
question_description string
question_type string
question_required boolean
answer_data any Flexible answer storage for different question types
requires_review boolean Internal flag - this answer requires additional review
user integer
user_name string
created string (date-time)
modified string (date-time)

List resource templates for a call

List resource templates for a call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resource_templates/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_list # (1)

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

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

try {
  const response = await proposalProtectedCallsResourceTemplatesList({
  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 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
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_retrieve # (1)

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

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

try {
  const response = await proposalProtectedCallsResourceTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

List rounds for a call

List rounds for a call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rounds/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_list # (1)

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

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

try {
  const response = await proposalProtectedCallsRoundsList({
  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 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
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_retrieve # (1)

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

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

try {
  const response = await proposalProtectedCallsRoundsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Activate a call

Activate a call.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/activate/ \
  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_protected_calls import proposal_protected_calls_activate # (1)

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

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

try {
  const response = await proposalProtectedCallsActivate({
  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)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Archive a call

Archive a call.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive/ \
  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_protected_calls import proposal_protected_calls_archive # (1)

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

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

try {
  const response = await proposalProtectedCallsArchive({
  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)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Attach documents to call

Attach documents to call.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach_documents/ \
  Authorization:"Token YOUR_API_TOKEN" \
  documents:='[]'
 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.call_attach_documents_request import CallAttachDocumentsRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_attach_documents # (2)

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

body_data = CallAttachDocumentsRequest(
    documents=[]
)
response = proposal_protected_calls_attach_documents.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsAttachDocuments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "documents": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid)
Field Type Required
documents array of string (binary)s
description string

200 - No response body


Detach documents from call

Detach documents from call.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detach_documents/ \
  Authorization:"Token YOUR_API_TOKEN" \
  documents:='[]'
 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.call_detach_documents_request import CallDetachDocumentsRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_detach_documents # (2)

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

body_data = CallDetachDocumentsRequest(
    documents=[]
)
response = proposal_protected_calls_detach_documents.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsDetachDocuments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "documents": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid)
Field Type Required
documents array of string (uuid)s

200 - No response body


Create offering for a call

Create offering for a call.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  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.requested_offering_request import RequestedOfferingRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_set # (2)

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

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

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

try {
  const response = await proposalProtectedCallsOfferingsSet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "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
offering string (uri)
attributes any
plan string (uri)
description string

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.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
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Create resource template for a call

Create resource template for a call.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resource_templates/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  requested_offering="https://api.example.com/api/requested-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.call_resource_template_request import CallResourceTemplateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_set # (2)

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

body_data = CallResourceTemplateRequest(
    name="my-awesome-proposal-protected-call",
    requested_offering="https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_resource_templates_set.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsResourceTemplatesSet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "requested_offering": "https://api.example.com/api/requested-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
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Mark proposal compliance as reviewed by call manager

Mark proposal compliance as reviewed by call manager.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/review_proposal_compliance/ \
  Authorization:"Token YOUR_API_TOKEN" \
  proposal_uuid="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.call_compliance_review_request import CallComplianceReviewRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_review_proposal_compliance # (2)

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

body_data = CallComplianceReviewRequest(
    proposal_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_review_proposal_compliance.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsReviewProposalCompliance({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "proposal_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
proposal_uuid string (uuid)
review_notes string

200 -


Close

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/close/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_call_request import ProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_close # (2)

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

body_data = ProtectedCallRequest(
    name="my-awesome-proposal-protected-call",
    manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_rounds_close.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsRoundsClose({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "manager": "https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string
Field Type Required Description
slug string
name string
description string
manager string (uri)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal submitters can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal submitters can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string

Create a round for a call

Create a round for a call.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rounds/ \
  Authorization:"Token YOUR_API_TOKEN" \
  start_time="2023-10-01T12:00:00Z" \
  cutoff_time="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.protected_round_request import ProtectedRoundRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_set # (2)

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

body_data = ProtectedRoundRequest(
    start_time="2023-10-01T12:00:00Z",
    cutoff_time="2023-10-01T12:00:00Z"
)
response = proposal_protected_calls_rounds_set.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsRoundsSet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "start_time": "2023-10-01T12:00:00Z",
    "cutoff_time": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid)
Field Type Required
start_time string (date-time)
cutoff_time string (date-time)
review_strategy string
deciding_entity string
allocation_time string
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/string-value/offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  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.requested_offering_request import RequestedOfferingRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_update # (2)

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

body_data = RequestedOfferingRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_offerings_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsOfferingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "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
obj_uuid string
uuid string
Field Type Required
offering string (uri)
attributes any
plan string (uri)
description string

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.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
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  requested_offering="https://api.example.com/api/requested-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
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_resource_template_request import CallResourceTemplateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_update # (2)

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

body_data = CallResourceTemplateRequest(
    name="my-awesome-proposal-protected-call",
    requested_offering="https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_resource_templates_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsResourceTemplatesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "requested_offering": "https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string
Field Type Required Description
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  start_time="2023-10-01T12:00:00Z" \
  cutoff_time="2023-10-01T12:00:00Z"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_round_request import ProtectedRoundRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_update # (2)

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

body_data = ProtectedRoundRequest(
    start_time="2023-10-01T12:00:00Z",
    cutoff_time="2023-10-01T12:00:00Z"
)
response = proposal_protected_calls_rounds_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsRoundsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "start_time": "2023-10-01T12:00:00Z",
    "cutoff_time": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string
Field Type Required
start_time string (date-time)
cutoff_time string (date-time)
review_strategy string
deciding_entity string
allocation_time string
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/string-value/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
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_requested_offering_request import PatchedRequestedOfferingRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_partial_update # (2)

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

body_data = PatchedRequestedOfferingRequest()
response = proposal_protected_calls_offerings_partial_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsOfferingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string
Field Type Required
attributes any
plan string (uri)
description string

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.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
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/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
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_resource_template_request import PatchedCallResourceTemplateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_partial_update # (2)

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

body_data = PatchedCallResourceTemplateRequest()
response = proposal_protected_calls_resource_templates_partial_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsResourceTemplatesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string
Field Type Required Description
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/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
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_protected_round_request import PatchedProtectedRoundRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_partial_update # (2)

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

body_data = PatchedProtectedRoundRequest()
response = proposal_protected_calls_rounds_partial_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsRoundsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string
Field Type Required
start_time string (date-time)
cutoff_time string (date-time)
review_strategy string
deciding_entity string
allocation_time string
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/string-value/offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_destroy # (1)

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

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

try {
  const response = await proposalProtectedCallsOfferingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string

204 - No response body


Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_destroy # (1)

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

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

try {
  const response = await proposalProtectedCallsResourceTemplatesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string

204 - No response body


Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_destroy # (1)

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

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

try {
  const response = await proposalProtectedCallsRoundsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string
uuid string

204 - No response body