Review groups of a row-stored analysis, in document order. An analysis stored whole answers 409 ANALYSIS_NOT_GROUPED; read it with GET /uploads/{id}/factor-agent/analysis. When any row of the analysis carries facets (a ledger's rows do), the first page (no cursor) adds facetSummary, totalRows and filteredRows, and every page takes the smart filter facets[<key>]=<value>: a key repeated ORs its values, keys AND. The filtered page holds the groups with at least one review row matching; each group's summary is still the whole group's. An analysis whose rows carry no facets answers as before, without those three keys, and refuses a filter with 400 FACETS_UNAVAILABLE. Facets never change an emission or what a submit sends.
Path parameters
Query parameters
The smart filter, facets[<key>]=<value>, repeated per value. Keys: journalType, journalSource, department, period (stored on the rows), carbon (carbon | non_carbon) and decisionSource (model | known | reviewer | rule | rule_unanswered | levy_rule). Values are 1 to 100 characters, at most 50 per key. An unknown key or value is 400 VALIDATION_ERROR.
Response
One page of review groups
Changes
Changed in 1 of the 6 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○