Docs
Get Candidates
GET /extractions/{extractionId}/candidates
GET
/extractions/{extractionId}/candidatesShortlists resources for the line match picker: the order's own needs first, then the event's resource types and variants whose names resemble the search text, up to 20. q is the search text; when q is empty, lineId uses that line's description instead. Each candidate has its name, variant, whether it is an order need, the rate card cost (only for a single standing fee) and, for an order need, the need id. Requires EventAdmin on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| extractionId | uuid | Required |
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| q | string | Optional | |
| lineId | uuid | Optional |
Response
| Field | Type | Description |
|---|---|---|
| candidates | GetFinancialDocumentExtractionCandidatesResponseCandidate[]| null |
GetFinancialDocumentExtractionCandidatesResponseCandidate
| Field | Type | Description |
|---|---|---|
| resourceTypeId | uuid | |
| resourceVariantId | uuid| null | |
| name | string| null | |
| variantName | string| null | |
| isOrderNeed | boolean | |
| rateCardCost | number| null | |
| procurementResourceId | uuid| null |