Bureau Query — Overview
This configuration defines WHAT will be queried. Actually triggering the query on the phase is done by an agriskphase action, a resource from the phase actions domain — it should not be confused with this configuration.
Endpoints in this domain
| Method | Path | Description |
|---|---|---|
GET | /v1/flows/{flowId}/phases/{phaseId}/query-config | Gets the phase's bureau query configuration |
POST | /v1/flows/{flowId}/phases/{phaseId}/query-config | Creates the phase's bureau query configuration |
PUT | /v1/flows/{flowId}/phases/{phaseId}/query-config | Updates the phase's bureau query configuration |
Recommended configuration pattern
1.
GET) whether a query configuration already exists for the phase.2.
POST) the configuration, providing title and the products[] list with the desired bureau/AgRisk product identifiers.3.
agrisk (phase actions domain), so the query is actually triggered when a card enters the phase.Important behaviors
POST/PUT is {title, products[]}. Both fields are required.products[] contains identifiers of the bureau/AgRisk products to be queried — available identifiers vary by environment and by the client's contracted products.POST is treated as an update: the API returns an error (409 or 422), and the same payload must be resubmitted via PUT on the same path to complete the update.PUT fully replaces the previous title and product list — this is not a partial merge.agrisk phase action. Creating the phase action without a previously defined query configuration is not blocked by the API, but the query will have no products defined to look up.agrisk phase action: the query-config defines which products will be queried; the agrisk phase action (part of the phase actions domain) enables the actual triggering of those queries when the card enters the phase.Modificado em 2026-07-28 20:38:32