Saltar al contenido principal
GET
List reports

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

status
string

Report status: Processing, Finished, Partial, Error, Draft or Final. Draft and Final belong to the regulatory cycle: a Draft is generated and still editable, a Final was approved.

template_id
string<uuid>

Template UUID; templateId is also accepted

document_id
string

Curated document the report files, for regulatory reports; documentId is also accepted

subscription_id
string<uuid>

Regulatory subscription the report files under; subscriptionId is also accepted

institution_id
string<uuid>

Institution the report read for, as frozen on it when it was requested; a report that read for no institution, or for every one, is left out. institutionId is also accepted

regulatory
enum<string>

true lists only regulatory filings (reports that record a document), false only operational reports

Opciones disponibles:
true,
false
current
enum<string>

true lists only the generation of each filing period that stands: a filing that is not Final is left out when a newer Draft or Final of the same subscription, dataBase and tipoRemessa exists. A Final is never left out. Accepted only on a list of filings (regulatory=true, document_id or subscription_id); every filing on such a list also carries supersededBy when something newer stands in its place

Opciones disponibles:
true,
false
created_at
string<date>

Creation date in YYYY-MM-DD format; createdAt is also accepted

sort_order
enum<string>
predeterminado:desc

Sort order. Applies when starting a walk; a cursor carries the order it was cut in, so it need not be repeated. Sending an order that disagrees with the cursor is refused.

Opciones disponibles:
asc,
desc
cursor
string

Opaque cursor from a previous response's nextCursor or prevCursor. Omit for the first page. It carries the sort order of the walk it belongs to, so following it resumes that walk.

limit
integer
predeterminado:10

Maximum reports per page

Respuesta

OK

items
object[] | null

Reports in the current page

Ejemplo:
limit
integer<int64>

Maximum number of reports in the page

Ejemplo:

10

nextCursor
string

Opaque cursor for the following page. Absent on the last page.

Ejemplo:

"eyJ0IjoiMjAyNi0wMS0zMVQxNTowMDowMFoiLCJpIjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAxIn0"

prevCursor
string

Opaque cursor for the preceding page. Absent on the first page.

Ejemplo:

"eyJ0IjoiMjAyNi0wMS0zMVQxNTowMDowMFoiLCJpIjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAxIiwiYiI6dHJ1ZX0"