Supported operations
This resource provides field metadata only. No dedicated CRUD endpoint is advertised.
Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
dealId | uuid | Required | deal Id Related resource: |
name | string | Required | name |
description | string | Optional | description |
status | enum | Optional | status Values: |
scheduledAt | datetime | Optional | scheduled At |
releasedAt | datetime | Optional | released At |
expiresAt | datetime | Optional | expires At |
minMatchScore | number | Optional | min Match Score |
includeAllMatches | boolean | Optional | include All Matches |
packageVersion | number | Optional | package Version |
proformaId | uuid | Optional | proforma Id |
proformaPresentationId | uuid | Optional | proforma Presentation Id |
dealSnapshot | json | Optional | deal Snapshot |
dealSnapshotHash | string | Optional | deal Snapshot Hash |
isStale | boolean | Optional | is Stale |
staleReason | string | Optional | stale Reason |
staleDetectedAt | datetime | Optional | stale Detected At |
requiresNda | boolean | Optional | requires Nda |
confidentialityLevel | string | Optional | confidentiality Level |
createdBy | string | Optional | created By |
releasedBy | string | Optional | released By |
cancelledBy | string | Optional | cancelled By |
cancelledReason | string | Optional | cancelled Reason |
notes | string | Optional | notes |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |