Skip to main content
GET
Read a filing's rows as its file shows them

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

reportId
string
required

Report identifier.

Response

OK

corrections
object[] | null
required

The correction trail, oldest first.

datasets
object
required

Every set of the filing, by name, rows in generation order. Numbers are strings of their exact digits; a corrected value is the text the person supplied.

documentId
string
required

Curated document the filing files.

Example:

"br.bcb.cadoc-4010"

documentVersion
string
required

Pinned document version the filing was generated against.

Example:

"1.4.2"

draftVersion
integer<int64>
required

Draft version these rows are. A correction presents it as If-Match.

Example:

2

openGaps
object[] | null
required

Fields still unfilled after the corrections; the draft cannot be approved while a required one is open.

parents
object
required

For each hierarchical set, each row's key mapped to the key of its nearest ancestor that is itself a row of the set. Rows with none are absent. Always an object.

reportId
string
required

Report identifier.

Example:

"00000000-0000-0000-0000-000000000001"

status
string
required

Draft or Final.

Example:

"Draft"