Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

reports

Search and list generated reports

post/app/v2/reports/search

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'display_name' | 'created_at' | 'updated_at'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "$or": [
      {
        "created_by": "c3e9446d-4cc0-4e7b-bb43-43fff9361957"
      },
      {
        "name": {
          "$like": "Subpart W"
        }
      }
    ]
  }
}

Response

List of generated reports

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "input": {
        "year_month": 202201,
        "reporting_group_id": "bc37cb31-08ce-4b22-8f4c-7d44692a4ef2",
        "asset_id": "89c100dc-0401-447f-a9f5-72ae124f3244"
      }
    }
  ]
}