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
POST /api/proposal-protected-calls/{uuid}/create-manual-assignment/ Create manual assignment
POST /api/proposal-protected-calls/{uuid}/update_applicant_attribute_config/ Create or update applicant attribute exposure configuration
PUT /api/proposal-protected-calls/{uuid}/ Update
PATCH /api/proposal-protected-calls/{uuid}/ Partial Update
PATCH /api/proposal-protected-calls/{uuid}/update_applicant_attribute_config/ Create or update applicant attribute exposure configuration
DELETE /api/proposal-protected-calls/{uuid}/ Delete
Permissions & Users
GET /api/proposal-protected-calls/{uuid}/list_users/ List users and their roles in a scope
POST /api/proposal-protected-calls/{uuid}/add_user/ Grant a role to a user
POST /api/proposal-protected-calls/{uuid}/delete_user/ Revoke a role from a user
POST /api/proposal-protected-calls/{uuid}/update_user/ Update a user's role expiration
Other Actions
GET /api/proposal-protected-calls/{uuid}/affinity-matrix/ Get affinity matrix for reviewer-proposal matching
GET /api/proposal-protected-calls/{uuid}/applicant_attribute_config/ Get applicant attribute exposure configuration for this call
GET /api/proposal-protected-calls/available_compliance_checklists/ Get available compliance checklists for call creation/editing
GET /api/proposal-protected-calls/{uuid}/coi-configuration/ Get COI configuration for this call
GET /api/proposal-protected-calls/{uuid}/compliance_overview/ Compliance overview
GET /api/proposal-protected-calls/{uuid}/conflict-summary/ Get summary statistics of conflicts for this call
GET /api/proposal-protected-calls/{uuid}/conflicts/ List all conflicts of interest detected for this call
GET /api/proposal-protected-calls/{uuid}/matching-configuration/ Get or update matching configuration for this call
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}/proposed-assignments/ Get proposed reviewer-proposal assignments
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}/reviewer-pool/ List reviewer pool members for a call
GET /api/proposal-protected-calls/{uuid}/rounds/ List rounds for a call
GET /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Retrieve
GET /api/proposal-protected-calls/{uuid}/suggestions/ List all reviewer suggestions for this call with affinity scores
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}/compute-affinities/ Compute affinity scores for all reviewer-proposal pairs
POST /api/proposal-protected-calls/{uuid}/detach_documents/ Detach documents from call
POST /api/proposal-protected-calls/{uuid}/detect-conflicts/ Trigger automated COI detection for all reviewer-proposal pairs
POST /api/proposal-protected-calls/{uuid}/generate-assignments/ Generate assignments
POST /api/proposal-protected-calls/{uuid}/generate-suggestions/ Generate reviewer suggestions with configurable matching source
POST /api/proposal-protected-calls/{uuid}/invite-by-email/ Invite by email
POST /api/proposal-protected-calls/{uuid}/reviewer-pool/ Invite reviewers to join the call's reviewer pool
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
POST /api/proposal-protected-calls/{uuid}/send-all-assignments/ Send all draft assignment batches for this call
POST /api/proposal-protected-calls/{uuid}/send-invitations/ Send invitations to all confirmed suggestions
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}/coi-configuration/ Get COI configuration for this call
PATCH /api/proposal-protected-calls/{uuid}/matching-configuration/ Get or update matching configuration for this call
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}/delete_applicant_attribute_config/ Delete custom applicant attribute config, reverting to system defaults
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
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_field_enum import ProtectedCallFieldEnum # (2)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (3)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_list # (4)

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. Model Source: CallStates
  2. Model Source: ProtectedCallFieldEnum
  3. Model Source: ProtectedCallOEnum
  4. 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 (uri)
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.
slug string Slug
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 URL-friendly identifier. Only editable by staff users.
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.offering_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.components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offerings.components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offerings.components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offerings.components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_call_field_enum import ProtectedCallFieldEnum # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_retrieve # (2)

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. Model Source: ProtectedCallFieldEnum
  2. 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 URL-friendly identifier. Only editable by staff users.
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.offering_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.components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offerings.components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offerings.components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offerings.components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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 URL-friendly identifier. Only editable by staff users.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants 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
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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 URL-friendly identifier. Only editable by staff users.
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.offering_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.components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offerings.components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offerings.components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offerings.components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Create manual assignment

Create a manual assignment batch for a specific reviewer. This allows call managers to manually assign proposals to reviewers.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create-manual-assignment/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reviewer_pool_entry_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  proposal_uuids:='[]'

 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.create_manual_assignment_request import CreateManualAssignmentRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_create_manual_assignment # (2)

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

body_data = CreateManualAssignmentRequest(
    reviewer_pool_entry_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    proposal_uuids=[]
)
response = proposal_protected_calls_create_manual_assignment.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsCreateManualAssignment({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "reviewer_pool_entry_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "proposal_uuids": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reviewer_pool_entry_uuid string (uuid) ✓ UUID of the reviewer pool entry to assign proposals to
proposal_uuids array of string (uuid)s ✓ List of proposal UUIDs to assign to the reviewer
manager_notes string Optional notes about this assignment

200 -

Field Type Description
batch_uuid string (uuid)
items_created integer
skipped_proposals array of objects Proposals that were skipped with reasons

Create or update applicant attribute exposure configuration

Create or update applicant attribute exposure configuration.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_applicant_attribute_config/ \
  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.call_applicant_attribute_config_request import CallApplicantAttributeConfigRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update_applicant_attribute_config # (2)

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

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

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

try {
  const response = await proposalProtectedCallsUpdateApplicantAttributeConfig({
  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
call string (uuid)
Constraints: write-only
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.
exposed_fields array of strings Return list of currently exposed field names.
is_default boolean Return True if this is a default (unsaved) config.

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 URL-friendly identifier. Only editable by staff users.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants 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
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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 URL-friendly identifier. Only editable by staff users.
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.offering_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.components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offerings.components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offerings.components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offerings.components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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 URL-friendly identifier. Only editable by staff users.
name string
description string
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants 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
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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 URL-friendly identifier. Only editable by staff users.
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.offering_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.components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offerings.components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offerings.components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offerings.components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Create or update applicant attribute exposure configuration

Create or update applicant attribute exposure configuration.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_applicant_attribute_config/ \
  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_call_applicant_attribute_config_request import PatchedCallApplicantAttributeConfigRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update_applicant_attribute_config_partial_update # (2)

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

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

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

try {
  const response = await proposalProtectedCallsUpdateApplicantAttributeConfigPartialUpdate({
  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
call string (uuid)
Constraints: write-only
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.
exposed_fields array of strings Return list of currently exposed field names.
is_default boolean Return True if this is a default (unsaved) config.

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 and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

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
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_list_users_list # (3)

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. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. 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)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

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 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

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 - Role revoked successfully.

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

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

Get affinity matrix for reviewer-proposal matching

Get affinity matrix for reviewer-proposal matching.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affinity-matrix/ \
  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.models.affinity_matrix_response_scope_enum import AffinityMatrixResponseScopeEnum # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_affinity_matrix_retrieve # (2)

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

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

try {
  const response = await proposalProtectedCallsAffinityMatrixRetrieve({
  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
scope string Filter by reviewer source: 'pool' (accepted reviewers), 'suggestions' (suggested reviewers), or 'all' (both). Default: 'pool'
Enum: all, pool, suggestions

200 -

Field Type
count integer
results array of objects
results.uuid string (uuid)
results.reviewer_uuid string (uuid)
results.reviewer_name string
results.proposal_uuid string (uuid)
results.proposal_name string
results.affinity_score number (double)
results.keyword_score number (double)
results.text_score number (double)
results.has_conflict boolean
results.coi_type string
results.coi_severity string
results.coi_status string
results.source string

Get applicant attribute exposure configuration for this call

Get applicant attribute exposure configuration for this call.

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

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

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

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

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.
exposed_fields array of strings Return list of currently exposed field names.
is_default boolean Return True if this is a default (unsaved) config.

Get available compliance checklists for call creation/editing

Get available compliance checklists for call creation/editing.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/available_compliance_checklists/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_available_compliance_checklists_list # (3)

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

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

try {
  const response = await proposalProtectedCallsAvailableComplianceChecklistsList({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
checklist_type string Filter by checklist type (default: proposal_compliance)
customer string (uri)
customer_keyword string
customer_uuid string ✓ Customer UUID to check permissions for. Required to verify user has CREATE_CALL permission on that customer's call managing organization.
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.
slug string Slug
state array

200 -

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

Field Type
uuid string (uuid)
name string
description string
checklist_type string
questions_count integer
category_name string
category_uuid string (uuid)

Get COI configuration for this call

Get COI configuration for this call.

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

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

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

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

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
coauthorship_lookback_years integer Years to look back for co-authorship detection
coauthorship_threshold_papers integer Minimum shared papers to trigger COI
institutional_lookback_years integer Years to look back for former institution detection
include_same_department boolean Detect same-department as COI
include_same_institution boolean Detect same-institution as COI
recusal_required_types array of strings COI types requiring automatic recusal
management_allowed_types array of strings COI types allowing management plan
disclosure_only_types array of strings COI types requiring disclosure only
auto_detect_coauthorship boolean Enable automated co-authorship detection
auto_detect_institutional boolean Enable automated institutional affiliation detection
auto_detect_named_personnel boolean Enable detection of reviewer named in proposals
invitation_proposal_disclosure any Level of proposal information disclosed in reviewer invitations
created string (date-time)
modified string (date-time)

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

Get summary statistics of conflicts for this call

Get summary statistics of conflicts for this call.

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

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

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

try {
  const response = await proposalProtectedCallsConflictSummaryRetrieve({
  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
total integer
by_status object (free-form)
by_severity object (free-form)
by_type object (free-form)

List all conflicts of interest detected for this call

List all conflicts of interest detected for this call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/conflicts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_conflicts_list # (3)

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

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

try {
  const response = await proposalProtectedCallsConflictsList({
  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
customer string (uri)
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.
slug string Slug
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)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Get or update matching configuration for this call

Get or update matching configuration for this call.

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

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

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

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

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
affinity_method string
Enum: keyword, tfidf, combined
keyword_weight number (double)
text_weight number (double)
min_reviewers_per_proposal integer
max_reviewers_per_proposal integer
min_proposals_per_reviewer integer
max_proposals_per_reviewer integer
algorithm string
Enum: minmax, fairflow, hungarian
min_affinity_threshold number (double) Minimum affinity score for FairFlow algorithm
use_reviewer_bids boolean
bid_weight number (double)
created string (date-time)
modified string (date-time)

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.offering_uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
components.min_renewal_duration integer Minimum number of months allowed for a renewal.
components.max_renewal_duration integer Maximum number of months allowed for a renewal.
components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
created string (date-time)
url string
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.offering_uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
components.min_renewal_duration integer Minimum number of months allowed for a renewal.
components.max_renewal_duration integer Maximum number of months allowed for a renewal.
components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
created string (date-time)
url string
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
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_proposals_compliance_answers_list # (3)

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. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. 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 (uri)
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.
slug string Slug
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)

Get proposed reviewer-proposal assignments

Get proposed reviewer-proposal assignments.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/proposed-assignments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_proposed_assignments_list # (3)

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

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

try {
  const response = await proposalProtectedCallsProposedAssignmentsList({
  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
customer string (uri)
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.
slug string Slug
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)
call string (uri)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
affinity_score number (double)
algorithm_used any
rank integer Assignment rank (1 = best match)
is_deployed boolean
deployed_at string (date-time)
deployed_by string (uri)
deployed_by_name string
created 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 reviewer pool members for a call

List reviewer pool members for a call.

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

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

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

try {
  const response = await proposalProtectedCallsReviewerPoolList({
  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
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_link string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.
override_reason string Reason for manager override of invitation status.
overridden_by_name string
overridden_at 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)

List all reviewer suggestions for this call with affinity scores

List all reviewer suggestions for this call with affinity scores.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/suggestions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_suggestions_list # (3)

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

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

try {
  const response = await proposalProtectedCallsSuggestionsList({
  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
customer string (uri)
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.
slug string Slug
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)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
reviewer_email string (email)
reviewer_biography string Professional biography / summary
affinity_score number (double) Combined affinity score (0-1)
keyword_score number (double) Keyword matching score
text_score number (double) TF-IDF text similarity score
status string
Enum: pending, confirmed, rejected, invited
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
rejection_reason string
matched_keywords any Keywords from reviewer's expertise that matched the source text
top_matching_proposals any Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...]
source_type any What content was used to generate this suggestion
source_type_display string
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
message 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
message 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

Compute affinity scores for all reviewer-proposal pairs

Compute affinity scores for all reviewer-proposal pairs.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compute-affinities/ \
  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_compute_affinities # (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_compute_affinities.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsComputeAffinities({
  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 URL-friendly identifier. Only editable by staff users.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants 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
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

200 -

Field Type
computed_count integer
message string

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

Trigger automated COI detection for all reviewer-proposal pairs

Trigger automated COI detection for all reviewer-proposal pairs.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detect-conflicts/ \
  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.trigger_coi_detection_request import TriggerCOIDetectionRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_detect_conflicts # (2)

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

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

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

try {
  const response = await proposalProtectedCallsDetectConflicts({
  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
job_type any

200 -

Field Type Description
url string Return URL for the job detail endpoint.
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
job_type any
state any
total_pairs integer
processed_pairs integer
progress_percentage number (double)
conflicts_found integer
started_at string (date-time)
completed_at string (date-time)
error_message string
created string (date-time)

Generate assignments

Generate assignment batches for reviewers. Uses the affinity matrix and COI records to assign reviewers to proposals.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/generate-assignments/ \
  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.generate_assignments_request import GenerateAssignmentsRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_generate_assignments # (2)

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

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

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

try {
  const response = await proposalProtectedCallsGenerateAssignments({
  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
proposal_uuids array of string (uuid)s Specific proposal UUIDs to generate assignments for. If empty, generates for all submitted proposals needing reviewers.
reviewers_per_proposal integer Number of reviewers to assign per proposal. If not specified, uses call's minimum_number_of_reviewers setting.

200 -

Field Type Description
batches_created integer
items_created integer
proposals_processed integer
skipped_proposals array of objects Proposals that were skipped with reasons

Generate reviewer suggestions with configurable matching source

Generate reviewer suggestions with configurable matching source.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/generate-suggestions/ \
  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.generate_suggestions_request_request import GenerateSuggestionsRequestRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_generate_suggestions # (2)

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

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

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

try {
  const response = await proposalProtectedCallsGenerateSuggestions({
  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
source any What content to match reviewers against
Constraints: default: all_proposals
proposal_uuids array of string (uuid)s Specific proposal UUIDs to match against (for selected_proposals source)
keywords array of strings Custom keywords to search for (for custom_keywords source)
keyword_search_mode any How to search for custom keywords
Constraints: default: expertise_only
min_affinity_threshold number (double) Minimum affinity score for suggestions (0.0-1.0)

200 -

Field Type
suggestions_created integer
reviewers_evaluated integer
source_used string
suggestions array of strings

Invite by email

Invite a reviewer by email address. Creates an invitation that requires the reviewer to create and publish a profile before accepting.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/invite-by-email/ \
  Authorization:"Token YOUR_API_TOKEN" \
  email="alice@example.com"

 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.email_invitation_request import EmailInvitationRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_invite_by_email # (2)

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

body_data = EmailInvitationRequest(
    email="alice@example.com"
)
response = proposal_protected_calls_invite_by_email.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await proposalProtectedCallsInviteByEmail({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
email string (email) ✓ Email address to send the invitation to
invitation_message string Custom message to include in invitation email
max_assignments integer
Constraints: default: 5

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_link string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.
override_reason string Reason for manager override of invitation status.
overridden_by_name string
overridden_at string (date-time)

Invite reviewers to join the call's reviewer pool

Invite reviewers to join the call's reviewer pool.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reviewer-pool/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reviewer_uuids:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.models.reviewer_invitation_request import ReviewerInvitationRequest # (3)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_invite_reviewers # (4)

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

body_data = ReviewerInvitationRequest(
    reviewer_uuids=[]
)
response = proposal_protected_calls_invite_reviewers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. Model Source: ReviewerInvitationRequest
  4. API Source: proposal_protected_calls_invite_reviewers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProtectedCallsInviteReviewers } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsInviteReviewers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "reviewer_uuids": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
customer string (uri)
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.
slug string Slug
state array
Field Type Required Description
reviewer_uuids array of string (uuid)s ✓ List of reviewer profile UUIDs to invite
max_assignments integer
Constraints: default: 5
invitation_message string Custom message to include in invitation email

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)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_link string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.
override_reason string Reason for manager override of invitation status.
overridden_by_name string
overridden_at string (date-time)

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.offering_uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
components.min_renewal_duration integer Minimum number of months allowed for a renewal.
components.max_renewal_duration integer Maximum number of months allowed for a renewal.
components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
created string (date-time)
url string
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 URL-friendly identifier. Only editable by staff users.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants 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
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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 URL-friendly identifier. Only editable by staff users.
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.offering_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.components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offerings.components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offerings.components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offerings.components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
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 applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

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)

Send all draft assignment batches for this call

Send all draft assignment batches for this call.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send-all-assignments/ \
  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.send_all_assignment_batches_request import SendAllAssignmentBatchesRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_send_all_assignments # (2)

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

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

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

try {
  const response = await proposalProtectedCallsSendAllAssignments({
  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
batch_uuids array of string (uuid)s Specific batch UUIDs to send. If empty, sends all draft batches.

200 -

Field Type
batches_sent integer
skipped integer

Send invitations to all confirmed suggestions

Send invitations to all confirmed suggestions.

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

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

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

try {
  const response = await proposalProtectedCallsSendInvitations({
  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
invitations_sent integer

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

Get COI configuration for this call

Get COI configuration for this call.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/coi-configuration/ \
  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_call_coi_configuration_request import PatchedCallCOIConfigurationRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_coi_configuration_partial_update # (2)

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

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

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

try {
  const response = await proposalProtectedCallsCoiConfigurationPartialUpdate({
  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
coauthorship_lookback_years integer Years to look back for co-authorship detection
coauthorship_threshold_papers integer Minimum shared papers to trigger COI
institutional_lookback_years integer Years to look back for former institution detection
include_same_department boolean Detect same-department as COI
include_same_institution boolean Detect same-institution as COI
recusal_required_types array of strings COI types requiring automatic recusal
management_allowed_types array of strings COI types allowing management plan
disclosure_only_types array of strings COI types requiring disclosure only
auto_detect_coauthorship boolean Enable automated co-authorship detection
auto_detect_institutional boolean Enable automated institutional affiliation detection
auto_detect_named_personnel boolean Enable detection of reviewer named in proposals
invitation_proposal_disclosure any Level of proposal information disclosed in reviewer invitations

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
coauthorship_lookback_years integer Years to look back for co-authorship detection
coauthorship_threshold_papers integer Minimum shared papers to trigger COI
institutional_lookback_years integer Years to look back for former institution detection
include_same_department boolean Detect same-department as COI
include_same_institution boolean Detect same-institution as COI
recusal_required_types array of strings COI types requiring automatic recusal
management_allowed_types array of strings COI types allowing management plan
disclosure_only_types array of strings COI types requiring disclosure only
auto_detect_coauthorship boolean Enable automated co-authorship detection
auto_detect_institutional boolean Enable automated institutional affiliation detection
auto_detect_named_personnel boolean Enable detection of reviewer named in proposals
invitation_proposal_disclosure any Level of proposal information disclosed in reviewer invitations
created string (date-time)
modified string (date-time)

Get or update matching configuration for this call

Get or update matching configuration for this call.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/matching-configuration/ \
  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_matching_configuration_request import PatchedMatchingConfigurationRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_matching_configuration_partial_update # (2)

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

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

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

try {
  const response = await proposalProtectedCallsMatchingConfigurationPartialUpdate({
  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
affinity_method string
Enum: keyword, tfidf, combined
keyword_weight number (double)
text_weight number (double)
min_reviewers_per_proposal integer
max_reviewers_per_proposal integer
min_proposals_per_reviewer integer
max_proposals_per_reviewer integer
algorithm string
Enum: minmax, fairflow, hungarian
min_affinity_threshold number (double) Minimum affinity score for FairFlow algorithm
use_reviewer_bids boolean
bid_weight number (double)

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
affinity_method string
Enum: keyword, tfidf, combined
keyword_weight number (double)
text_weight number (double)
min_reviewers_per_proposal integer
max_reviewers_per_proposal integer
min_proposals_per_reviewer integer
max_proposals_per_reviewer integer
algorithm string
Enum: minmax, fairflow, hungarian
min_affinity_threshold number (double) Minimum affinity score for FairFlow algorithm
use_reviewer_bids boolean
bid_weight number (double)
created string (date-time)
modified 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.offering_uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
components.min_renewal_duration integer Minimum number of months allowed for a renewal.
components.max_renewal_duration integer Maximum number of months allowed for a renewal.
components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
created string (date-time)
url string
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 custom applicant attribute config, reverting to system defaults

Delete custom applicant attribute config, reverting to system defaults.

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

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

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

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

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