Bid APIs¶
Why This Exists¶
This document defines API responsibilities for the Bid Domain.
It does not define implementation code or final OpenAPI specifications.
Owner¶
The owner is the Chief Product Officer and Enterprise Architect.
Business Value¶
Bid APIs expose governed bid workspace, planning, drafting, approval, submission, and outcome behavior.
API Groups¶
| API group | Responsibilities | Example endpoints |
|---|---|---|
| Tender Workspace API | Create and manage workspaces. | POST /bids/workspaces, GET /bids/workspaces/{workspaceId} |
| Bid Plan API | Manage bid plan and milestones. | POST /bids/workspaces/{id}/plan |
| Bid Task API | Manage bid tasks. | POST /bids/workspaces/{id}/tasks, PATCH /bids/tasks/{taskId} |
| Collaboration API | Manage comments and internal discussion. | POST /bids/workspaces/{id}/comments |
| Proposal Draft API | Manage proposal drafts and sections. | POST /bids/workspaces/{id}/drafts, PATCH /bids/sections/{sectionId} |
| SBD Form API | Manage SBD forms. | POST /bids/workspaces/{id}/sbd-forms |
| Pricing API | Manage pricing workbook and BOQ references. | POST /bids/workspaces/{id}/pricing-workbook |
| Approval API | Manage approval workflow. | POST /bids/workspaces/{id}/approvals |
| Submission API | Manage checklists and packs. | POST /bids/workspaces/{id}/submission-pack |
| Outcome API | Capture outcome, loss feedback, lessons. | POST /bids/workspaces/{id}/outcome |
API Principles¶
- APIs must not mutate Opportunity, Organization, Compliance, or Intelligence source facts.
- APIs may accept Intelligence suggestions only through Bid-owned actions.
- APIs must enforce approval and submission readiness rules.
- APIs must preserve audit history for submission and approval records.