Playground

Playground

RfpRecord

/api/v1/rfp/records

An incoming RFP being tracked.

listgetcreateupdate

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
rfp_numberstringCounter-driven, human-readable RFP number.
titlestringShort descriptive title for the RFP.
descriptionstringDetailed description of the RFP.
account_idstringID of the sourcing customer Account.
procurement_contact_idstringID of the buyer-side procurement Contact.
deal_idstringID of the linked Deal once qualified.
owner_idstringID of the bid manager / deal owner (usr-<uuid>).
department_group_idstringID of the routing target department Group.
parent_rfp_idstringID of the parent RFP for amendments or addenda.
child_rfp_idsjsonIDs of child RFPs (amendments, addenda).
statusstringCurrent lifecycle status of the RFP.
bid_decisionstringBid/no-bid decision.
phasestringCurrent authoring phase of the RFP.
submission_deadlinedate-timeISO 8601 timestamp of the submission deadline.
submission_methodstringHow the proposal should be submitted (e.g. 'portal:SAP-Ariba').
slajsonSLA tracking: dueAt, breached flag, and optional breachedAt.
sla_milestonesjsonOrdered list of SLA milestones with per-milestone status.
mail_metadatajsonOutlook mail metadata if source=outlook.
attachment_refsjsonMinIO keys for source RFP attachments.
proposal_refsjsonMinIO keys for generated proposal documents.
extracted_document_idsjsonIDs of documents ingested into cpod-arai (doc-<uuid>).
question_idsjsonIDs of all extracted RfpQuestions (rfq-<uuid>).
response_idsjsonIDs of all drafted RfpResponses (rfa-<uuid>).
ai_enrichmentjsonAI-generated enrichment: execSummary, riskScore, pricingHint, recommendation, modelUsed, generatedAt.
reviewersjsonIDs of required reviewers (usr-<uuid>).
approversjsonIDs of required approvers (usr-<uuid>).
submitted_atdate-timeISO 8601 timestamp when the proposal was submitted.
submitted_bystringID of the user who submitted the proposal.
outcomejsonOutcome record: status, decidedAt, decidedBy, notes.
custom_fieldsjsonTenant-defined custom fields.
tagsjsonFree-form tags.
versionnumberOptimistic concurrency version counter.
sourceenumoutlook | portal | manual | api | email_forwardChannel through which the RFP was received.
priorityenumlow | medium | high | urgentPriority assigned to this RFP.
metricsjsonRollup status counts (questions/responses totals).
file_bytesstringBase64-encoded bytes of the source RFP file.
file_namestringOriginal file name of the source RFP.
file_size_bytesintegerSize of the source file in bytes.
file_mimestringMIME type of the source file.

API

client.rfp.records.*
Loading manifest…