Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Preconstruction

Bidding

32 endpoints30 implementedAll modules →
  1. PATCH /rest/v1.0/bidding/recipient/{id}Submit or decline a bid through a scoped invitation
  2. GET /rest/v1.0/bidding/recipient/{id}/addendum_acknowledgmentsShow current reviewed addendum and this recipient's retained acknowledgment history
  3. POST /rest/v1.0/bidding/recipient/{id}/addendum_acknowledgmentsAcknowledge the exact current reviewed addendum before submitting a quote
  4. GET /rest/v1.0/bidding/recipient/{id}/submission_receiptsList only this authenticated invitation's immutable quote revisions
  5. POST /rest/v1.0/projects/{project_id}/bid_packagesCreate Bid Package
  6. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/addendum_acknowledgmentsList retained bidder acknowledgments of reviewed package addenda; staff only
  7. PATCH /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/awardAward a submitted, reconciled bid
  8. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendationsList retained staff award recommendations and independently approved current decision
  9. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendationsPropose a reasoned selection against an exact fresh quote comparison
  10. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendations/{recommendation_id}/approveIndependently approve the exact current recommendation; Bidding administrator only
  11. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendations/previewPreview exact current frozen quotes for a staff award recommendation
  12. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bid_forms/{bid_form_id}/bid_levelingBid leveling across a bid form
  13. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bidsList Bids within a Bid Package
  14. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bidsInvite vendors to a bid package
  15. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}Show Bids within a Bid package
  16. PATCH /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}Update a Bid from a Bid Package
  17. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/buyout_planRead the immutable approved vendor buyout plan
  18. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/buyout_planApprove an immutable vendor buyout plan after preview review
  19. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/buyout_plan/previewPreview private vendor buyout allocations against a captured Budget snapshot
  20. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/commitment_receiptRead the private immutable award to commitment source receipt
  21. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/submission_receiptsList immutable quote revisions for one bidder; staff only
  22. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/create_commitmentCreate or recover a private draft commitment from the award
  23. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/releaseRead the current vendor package release and paginated immutable release history
  24. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/releaseApprove a vendor-visible bid package release from an exact short-lived review
  25. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachmentsList classified attachment evidence for one vendor package, including retained withdrawals
  26. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachmentsClassify a verified private upload for a draft vendor package
  27. DELETE /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachments/{attachment_id}Withdraw a classified attachment from future vendor releases while retaining evidence
  28. GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachments/{attachment_id}/downloadInspect exact classified attachment bytes before approving a vendor release
  29. POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/previewPreview the exact vendor-visible bid package before a reviewed release
  30. GET /rest/v1.0/projects/{project_id}/bid_packages/{id}Show Bid Package
  31. PATCH /rest/v1.0/projects/{project_id}/bid_packages/{id}Update Bid Package
  32. GET /rest/v1.1/projects/{project_id}/bid_packagesList Bid Packages
PATCH /rest/v1.0/bidding/recipient/{id}

Submit or decline a bid through a scoped invitation

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • x-bid-invitation-token
    stringheaderrequired

Request body

  • action
    stringrequired
  • request_key
    string (uuid)
  • bid
    object

Response · 200 · object

  • ok
    booleanrequired
GET /rest/v1.0/bidding/recipient/{id}/addendum_acknowledgments

Show current reviewed addendum and this recipient's retained acknowledgment history

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • x-bid-invitation-token
    stringheaderrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • addendum
    BidAddendumCurrent | stringrequired
  • acknowledgments
    BidAddendumAcknowledgment[]required
  • total
    integerrequired
POST /rest/v1.0/bidding/recipient/{id}/addendum_acknowledgments

Acknowledge the exact current reviewed addendum before submitting a quote

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • x-bid-invitation-token
    stringheaderrequired

Request body

  • release_version_id
    integerrequired
  • release_sha256
    stringrequired
  • request_key
    string (uuid)required

Response · 201 · BidAddendumAcknowledgment

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • bid_package_id
    integerrequired
  • invitation_id
    integerrequired
  • recipient_user_id
    integerrequired
  • release_version_id
    integerrequired
  • release_sha256
    stringrequired
  • source_sha256
    stringrequired
  • changed_fields
    BidAddendumChangedField[]required
  • acknowledged_at
    string (date-time)required
GET /rest/v1.0/bidding/recipient/{id}/submission_receipts

List only this authenticated invitation's immutable quote revisions

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • x-bid-invitation-token
    stringheaderrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • receipts
    BidSubmissionReceiptRecipient[]required
  • total
    integerrequired
POST /rest/v1.0/projects/{project_id}/bid_packages

Create Bid Package

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Request body

  • bid_package
    objectrequired

Response · 201 · object

  • accept_post_due_submissions
    boolean
  • accounting_method
    string
  • allow_bidder_sum
    boolean
  • project_currency_iso_code
    string
  • project_currency_display
    string
  • anticipated_award_date
    string (date)
  • bidding_countdown_email_days
    integer
  • bid_docs_manifest
    object
  • bid_due_date
    string (date-time)
  • bid_email_message
    string
  • bid_emails_include_link_to_bidding_documents
    boolean
  • bid_submission_confirmation
    string
  • bid_web_message
    string
  • blind_bidding
    boolean
  • created_by
    object
  • distribution_members
    object[]
  • display_project_name
    boolean
  • bid_form_sections_enabled
    boolean
  • flexible_response_types_enabled
    boolean
  • distribution_member_ids
    integer[]
  • enable_countdown_emails
    boolean
  • enable_prebid_rfi_deadline
    boolean
  • enable_prebid_walkthrough
    boolean
  • has_any_bid_invited
    boolean
  • has_bids_sent_nda
    boolean
  • has_no_nda_activity
    boolean
  • nda_invited_bids_with_activity_count
    integer
  • attachments_zip_streaming_url
    string
  • hidden
    boolean
  • id
    integer
  • links
    object
  • lump_sum_bidding
    boolean
  • manager
    object
  • nda_attachments
    object[]
  • number
    integer
  • open
    boolean
  • release_required
    boolean
  • vendor_revision
    integer
  • point_of_contact
    object
  • point_of_contact_login_id
    integer
  • pre_bid_rfi_deadline_date
    string (date-time)
  • pre_bid_walk_through_date
    string (date-time)
  • pre_bid_walk_through_notes
    string
  • project_id
    integer
  • project_image_url
    string
  • project_logo_name
    string
  • project_logo_url
    string
  • project_latitude
    string
  • project_location
    string
  • project_longitude
    string
  • project_name
    string
  • require_nda
    boolean
  • sealed
    boolean
  • show_bid_info
    boolean
  • submitted_bids_count
    integer
  • title
    string
  • enable_public_discovery
    boolean
  • primary_slug_with_ids
    string
  • pre_bid_meeting_location
    string
  • pre_bid_meeting_date
    string (date-time)
  • pre_bid_meeting_online_link
    string
  • pre_bid_meeting_notes
    string
  • public_project_funding_source
    string
  • show_location_for_nda_projects
    boolean
  • public_bid_opening_details_date
    string (date-time)
  • public_bid_opening_details_location
    string
  • public_bid_opening_details_online_link
    string (uri)
  • trades_and_services
    object[]
  • business_classifications
    object[]
  • lock_unit_fields_base_bid
    boolean
  • lock_quantity_fields_base_bid
    boolean
  • lock_unit_fields_alternates
    boolean
  • lock_quantity_fields_alternates
    boolean
  • has_pdm_documents
    boolean
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/addendum_acknowledgments

List retained bidder acknowledgments of reviewed package addenda; staff only

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • acknowledgments
    BidAddendumAcknowledgment[]required
  • total
    integerrequired
  • current_version_total
    integerrequired
PATCH /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award

Award a submitted, reconciled bid

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired

Request body

  • bid_id
    integerrequired

Response · 200 · object

  • id
    integer
  • status
    string
  • bids
    object[]
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendations

List retained staff award recommendations and independently approved current decision

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • current
    BidAwardRecommendation | stringrequired
  • recommendations
    BidAwardRecommendation[]required
  • total
    integerrequired
POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendations

Propose a reasoned selection against an exact fresh quote comparison

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired

Request body

  • bid_id
    integerrequired
  • source_sha256
    stringrequired
  • reason
    stringrequired
  • request_key
    string (uuid)required
  • scope_exceptions
    string[]
  • alternates_note
    string
  • qualifications_note
    string
  • schedule_note
    string
  • cost_code_note
    string
  • selected_cost_code_ids
    integer[]

Response · 201 · BidAwardRecommendation

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • bid_package_id
    integerrequired
  • release_version_id
    integerrequired
  • selected_bid_id
    integerrequired
  • selected_receipt_id
    integerrequired
  • status
    stringrequired
  • source_sha256
    stringrequired
  • source_snapshot
    BidAwardComparisonSnapshotrequired
  • review_sha256
    stringrequired
  • review_snapshot
    BidAwardReviewSnapshotrequired
  • proposer_id
    integerrequired
  • proposal_reason
    stringrequired
  • proposed_at
    string (date-time)required
  • approver_id
    integerrequired
  • approval_reason
    stringrequired
  • approved_at
    string (date-time)required
  • superseded_at
    string (date-time)required
POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendations/{recommendation_id}/approve

Independently approve the exact current recommendation; Bidding administrator only

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • recommendation_id
    integerpathrequired

Request body

  • source_sha256
    stringrequired
  • reason
    stringrequired
  • request_key
    string (uuid)required

Response · 200 · BidAwardRecommendation

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • bid_package_id
    integerrequired
  • release_version_id
    integerrequired
  • selected_bid_id
    integerrequired
  • selected_receipt_id
    integerrequired
  • status
    stringrequired
  • source_sha256
    stringrequired
  • source_snapshot
    BidAwardComparisonSnapshotrequired
  • review_sha256
    stringrequired
  • review_snapshot
    BidAwardReviewSnapshotrequired
  • proposer_id
    integerrequired
  • proposal_reason
    stringrequired
  • proposed_at
    string (date-time)required
  • approver_id
    integerrequired
  • approval_reason
    stringrequired
  • approved_at
    string (date-time)required
  • superseded_at
    string (date-time)required
POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/award_recommendations/preview

Preview exact current frozen quotes for a staff award recommendation

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired

Request body

  • bid_id
    integerrequired

Response · 200 · BidAwardRecommendationPreview

  • source_sha256
    stringrequired
  • release_version_id
    integerrequired
  • selected_receipt_id
    integerrequired
  • snapshot
    BidAwardComparisonSnapshotrequired
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bid_forms/{bid_form_id}/bid_leveling

Bid leveling across a bid form

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bid_package_id
    stringpathrequired
  • bid_form_id
    stringpathrequired

Response · 200 · object

  • bid_package_id
    integerrequired
  • accounting_method
    string
  • low_total
    number
  • low_total_bid_ids
    integer[]
  • columns
    object[]required
  • base_bid_section
    objectrequired
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids

List Bids within a Bid Package

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • page
    integerquery
  • per_page
    integerquery
  • project_id
    stringpathrequired
  • bid_package_id
    stringpathrequired

Response · 200 · object[]

  • id
    integer
  • bid_package_id
    integer
  • bid_package_title
    string
  • bid_form_title
    string
  • bid_form_id
    integer
  • bid_status
    string
  • awarded
    boolean
  • company_id
    integer
  • invitation_last_sent_at
    string (date-time)
  • is_bidder_committed
    boolean
  • lump_sum_amount
    number (float)
  • lump_sum_enabled
    boolean
  • submitted
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • due_date
    string (date-time)
  • bidder_comments
    string
  • bid_requester
    object
  • vendor
    object
  • project
    object
POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids

Invite vendors to a bid package

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bid_package_id
    stringpathrequired

Response · 201 · object[]

  • id
    integer
  • bid_package_id
    integer
  • bid_package_title
    string
  • bid_form_title
    string
  • bid_form_id
    integer
  • bid_status
    string
  • awarded
    boolean
  • company_id
    integer
  • invitation_last_sent_at
    string (date-time)
  • is_bidder_committed
    boolean
  • lump_sum_amount
    number (float)
  • lump_sum_enabled
    boolean
  • submitted
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • due_date
    string (date-time)
  • bidder_comments
    string
  • bid_requester
    object
  • vendor
    object
  • project
    object
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}

Show Bids within a Bid package

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • id
    integerpathrequired
  • project_id
    stringpathrequired
  • bid_package_id
    stringpathrequired

Response · 200 · object

  • id
    integer
  • bid_package_id
    integer
  • bid_package_title
    string
  • bid_form_title
    string
  • awarded
    boolean
  • bidders_can_add_line_items
    boolean
  • bid_status
    string
  • company_id
    integer
  • invitation_last_sent_at
    string (date-time)
  • is_bidder_committed
    boolean
  • lump_sum_amount
    number (float)
  • lump_sum_enabled
    boolean
  • submitted
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • due_date
    string (date-time)
  • bidder_comments
    string
  • show_bid_in_estimating
    boolean
  • bid_amount
    string (currency)
  • bid_requester
    object
  • deleted_at
    string (date-time)
  • bidder_notes
    string
  • attachments_count
    integer
  • recipient_ids
    integer[]
  • recipient_list
    object[]
  • recipient_list_with_email_and_number
    string[]
  • mailto
    string
  • bidder_inclusion
    string
  • bidder_exclusion
    string
  • bid_convertible_to_subcontract
    boolean
  • bid_convertible_to_purchase_order
    boolean
  • contract_button_disabled_reason
    string
  • po_button_disabled_reason
    string
  • links
    object
  • vendor
    object
  • project
    object
  • bid_items
    object[]
  • cost_codes
    object[]
  • attachments
    object[]
  • attachments_zip_streaming_url
    string
  • values_converted_by_name
    string
  • values_converted_at
    string (date-time)
  • values_modified_by_name
    string
  • values_modified_at
    string (date-time)
PATCH /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}

Update a Bid from a Bid Package

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • id
    integerpathrequired
  • project_id
    stringpathrequired
  • bid_package_id
    stringpathrequired

Request body

  • bid
    object

Response · 200 · object

  • id
    integer
  • bid_package_id
    integer
  • bid_package_title
    string
  • bid_form_title
    string
  • awarded
    boolean
  • bidders_can_add_line_items
    boolean
  • bid_status
    string
  • company_id
    integer
  • invitation_last_sent_at
    string (date-time)
  • is_bidder_committed
    boolean
  • lump_sum_amount
    number (float)
  • lump_sum_enabled
    boolean
  • submitted
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • due_date
    string (date-time)
  • bidder_comments
    string
  • show_bid_in_estimating
    boolean
  • bid_amount
    string (currency)
  • bid_requester
    object
  • deleted_at
    string (date-time)
  • bidder_notes
    string
  • attachments_count
    integer
  • recipient_ids
    integer[]
  • recipient_list
    object[]
  • recipient_list_with_email_and_number
    string[]
  • mailto
    string
  • bidder_inclusion
    string
  • bidder_exclusion
    string
  • bid_convertible_to_subcontract
    boolean
  • bid_convertible_to_purchase_order
    boolean
  • contract_button_disabled_reason
    string
  • po_button_disabled_reason
    string
  • links
    object
  • vendor
    object
  • project
    object
  • bid_items
    object[]
  • cost_codes
    object[]
  • attachments
    object[]
  • attachments_zip_streaming_url
    string
  • values_converted_by_name
    string
  • values_converted_at
    string (date-time)
  • values_modified_by_name
    string
  • values_modified_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/buyout_plan

Read the immutable approved vendor buyout plan

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

No documented fields.

POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/buyout_plan

Approve an immutable vendor buyout plan after preview review

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • snapshot_id
    integerrequired
  • allocations
    object[]required
  • review_token
    stringrequired
  • request_key
    string (uuid)

Response · 200 · object

No documented fields.

POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/buyout_plan/preview

Preview private vendor buyout allocations against a captured Budget snapshot

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • snapshot_id
    integerrequired
  • allocations
    object[]required

Response · 200 · object

No documented fields.

GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/commitment_receipt

Read the private immutable award to commitment source receipt

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integerrequired
  • project_id
    integerrequired
  • bid_package_id
    integerrequired
  • bid_id
    integerrequired
  • vendor_id
    integerrequired
  • commitment_type
    stringrequired
  • commitment_id
    integerrequired
  • awarded_amount
    stringrequired
  • source_sha256
    stringrequired
  • source_snapshot
    objectrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/bids/{id}/submission_receipts

List immutable quote revisions for one bidder; staff only

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • receipts
    BidSubmissionReceiptStaff[]required
  • total
    integerrequired
POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/create_commitment

Create or recover a private draft commitment from the award

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired

Request body

  • bid_id
    integerrequired
  • commitment_type
    string
  • fallback_cost_code_id
    integer

Response · 200 · object

  • commitment_id
    integerrequired
  • commitment_type
    stringrequired
  • created
    booleanrequired
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release

Read the current vendor package release and paginated immutable release history

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • current
    objectrequired
  • versions
    object[]required
  • total
    integerrequired
POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release

Approve a vendor-visible bid package release from an exact short-lived review

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired

Request body

  • review_token
    stringrequired
  • request_key
    stringrequired
  • reason
    stringrequired

Response · 200 · object

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • bid_package_id
    integerrequired
  • package_revision
    integerrequired
  • version
    integerrequired
  • addendum_ack_required
    booleanrequired
  • reviewed_by_id
    integerrequired
  • reason
    stringrequired
  • snapshot_sha256
    stringrequired
  • snapshot
    BidPackageVendorSnapshotrequired
  • approved_at
    string (date-time)required
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachments

List classified attachment evidence for one vendor package, including retained withdrawals

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • attachments
    BidPackageReleaseAttachment[]required
  • total
    integerrequired
POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachments

Classify a verified private upload for a draft vendor package

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired

Response · 200 · BidPackageReleaseAttachment

  • id
    integerrequired
  • bid_package_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • classification
    stringrequired
  • classification_reason
    stringrequired
  • scan_mode
    stringrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • removed_at
    string (date-time)required
  • removed_by_id
    integerrequired
  • removal_reason
    stringrequired
DELETE /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachments/{attachment_id}

Withdraw a classified attachment from future vendor releases while retaining evidence

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • attachment_id
    integerpathrequired

Request body

  • reason
    stringrequired

Response · 200 · BidPackageReleaseAttachment

  • id
    integerrequired
  • bid_package_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • classification
    stringrequired
  • classification_reason
    stringrequired
  • scan_mode
    stringrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • removed_at
    string (date-time)required
  • removed_by_id
    integerrequired
  • removal_reason
    stringrequired
GET /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/attachments/{attachment_id}/download

Inspect exact classified attachment bytes before approving a vendor release

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired
  • attachment_id
    integerpathrequired

Response · 200 · string (binary)

No documented fields.

POST /rest/v1.0/projects/{project_id}/bid_packages/{bid_package_id}/release/preview

Preview the exact vendor-visible bid package before a reviewed release

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • bid_package_id
    integerpathrequired

Response · 200 · object

  • review_token
    stringrequired
  • expires_at
    string (date-time)required
  • snapshot_sha256
    stringrequired
  • package_revision
    integerrequired
  • snapshot
    BidPackageVendorSnapshotrequired
GET /rest/v1.0/projects/{project_id}/bid_packages/{id}

Show Bid Package

v1.0Documented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • accept_post_due_submissions
    boolean
  • accounting_method
    string
  • allow_bidder_sum
    boolean
  • project_currency_iso_code
    string
  • project_currency_display
    string
  • anticipated_award_date
    string (date)
  • bidding_countdown_email_days
    integer
  • bid_docs_manifest
    object
  • bid_due_date
    string (date-time)
  • bid_email_message
    string
  • bid_emails_include_link_to_bidding_documents
    boolean
  • bid_submission_confirmation
    string
  • bid_web_message
    string
  • blind_bidding
    boolean
  • created_by
    object
  • distribution_members
    object[]
  • display_project_name
    boolean
  • bid_form_sections_enabled
    boolean
  • flexible_response_types_enabled
    boolean
  • distribution_member_ids
    integer[]
  • enable_countdown_emails
    boolean
  • enable_prebid_rfi_deadline
    boolean
  • enable_prebid_walkthrough
    boolean
  • has_any_bid_invited
    boolean
  • has_bids_sent_nda
    boolean
  • has_no_nda_activity
    boolean
  • nda_invited_bids_with_activity_count
    integer
  • attachments_zip_streaming_url
    string
  • hidden
    boolean
  • id
    integer
  • links
    object
  • lump_sum_bidding
    boolean
  • manager
    object
  • nda_attachments
    object[]
  • number
    integer
  • open
    boolean
  • release_required
    boolean
  • vendor_revision
    integer
  • point_of_contact
    object
  • point_of_contact_login_id
    integer
  • pre_bid_rfi_deadline_date
    string (date-time)
  • pre_bid_walk_through_date
    string (date-time)
  • pre_bid_walk_through_notes
    string
  • project_id
    integer
  • project_image_url
    string
  • project_logo_name
    string
  • project_logo_url
    string
  • project_latitude
    string
  • project_location
    string
  • project_longitude
    string
  • project_name
    string
  • require_nda
    boolean
  • sealed
    boolean
  • show_bid_info
    boolean
  • submitted_bids_count
    integer
  • title
    string
  • enable_public_discovery
    boolean
  • primary_slug_with_ids
    string
  • pre_bid_meeting_location
    string
  • pre_bid_meeting_date
    string (date-time)
  • pre_bid_meeting_online_link
    string
  • pre_bid_meeting_notes
    string
  • public_project_funding_source
    string
  • show_location_for_nda_projects
    boolean
  • public_bid_opening_details_date
    string (date-time)
  • public_bid_opening_details_location
    string
  • public_bid_opening_details_online_link
    string (uri)
  • trades_and_services
    object[]
  • business_classifications
    object[]
  • lock_unit_fields_base_bid
    boolean
  • lock_quantity_fields_base_bid
    boolean
  • lock_unit_fields_alternates
    boolean
  • lock_quantity_fields_alternates
    boolean
  • has_pdm_documents
    boolean
PATCH /rest/v1.0/projects/{project_id}/bid_packages/{id}

Update Bid Package

v1.0Documented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • bid_package
    objectrequired

Response · 200 · object

  • accept_post_due_submissions
    boolean
  • accounting_method
    string
  • allow_bidder_sum
    boolean
  • project_currency_iso_code
    string
  • project_currency_display
    string
  • anticipated_award_date
    string (date)
  • bidding_countdown_email_days
    integer
  • bid_docs_manifest
    object
  • bid_due_date
    string (date-time)
  • bid_email_message
    string
  • bid_emails_include_link_to_bidding_documents
    boolean
  • bid_submission_confirmation
    string
  • bid_web_message
    string
  • blind_bidding
    boolean
  • created_by
    object
  • distribution_members
    object[]
  • display_project_name
    boolean
  • bid_form_sections_enabled
    boolean
  • flexible_response_types_enabled
    boolean
  • distribution_member_ids
    integer[]
  • enable_countdown_emails
    boolean
  • enable_prebid_rfi_deadline
    boolean
  • enable_prebid_walkthrough
    boolean
  • has_any_bid_invited
    boolean
  • has_bids_sent_nda
    boolean
  • has_no_nda_activity
    boolean
  • nda_invited_bids_with_activity_count
    integer
  • attachments_zip_streaming_url
    string
  • hidden
    boolean
  • id
    integer
  • links
    object
  • lump_sum_bidding
    boolean
  • manager
    object
  • nda_attachments
    object[]
  • number
    integer
  • open
    boolean
  • release_required
    boolean
  • vendor_revision
    integer
  • point_of_contact
    object
  • point_of_contact_login_id
    integer
  • pre_bid_rfi_deadline_date
    string (date-time)
  • pre_bid_walk_through_date
    string (date-time)
  • pre_bid_walk_through_notes
    string
  • project_id
    integer
  • project_image_url
    string
  • project_logo_name
    string
  • project_logo_url
    string
  • project_latitude
    string
  • project_location
    string
  • project_longitude
    string
  • project_name
    string
  • require_nda
    boolean
  • sealed
    boolean
  • show_bid_info
    boolean
  • submitted_bids_count
    integer
  • title
    string
  • enable_public_discovery
    boolean
  • primary_slug_with_ids
    string
  • pre_bid_meeting_location
    string
  • pre_bid_meeting_date
    string (date-time)
  • pre_bid_meeting_online_link
    string
  • pre_bid_meeting_notes
    string
  • public_project_funding_source
    string
  • show_location_for_nda_projects
    boolean
  • public_bid_opening_details_date
    string (date-time)
  • public_bid_opening_details_location
    string
  • public_bid_opening_details_online_link
    string (uri)
  • trades_and_services
    object[]
  • business_classifications
    object[]
  • lock_unit_fields_base_bid
    boolean
  • lock_quantity_fields_base_bid
    boolean
  • lock_unit_fields_alternates
    boolean
  • lock_quantity_fields_alternates
    boolean
  • has_pdm_documents
    boolean
GET /rest/v1.1/projects/{project_id}/bid_packages

List Bid Packages

v1.1Implemented

Parameters

  • page
    integerquery
  • per_page
    integerquery
  • view
    stringquery
  • filter
    stringquery
  • with_flags
    string[]query
  • sort
    stringquery
  • filters[bid_due_date]
    string (date)query
  • filters[status]
    stringquery
  • filters[created_at]
    stringquery
  • filters[has_bid_forms]
    booleanquery
  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integer
  • project_id
    integer
  • bid_due_date
    string (date-time)
  • created_at
    string (date-time)
  • number
    integer
  • title
    string
  • release_required
    boolean
  • vendor_revision
    integer
  • submitted_bids_count
    integer

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file