Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

reports

Trigger report generation

post/app/v3/reports

Request body

namestring required
templated_report_namestring required
inputobject

User input for a templated report based on the input schema for the desired templated report.

Example request

{
  "input": {
    "year_month": 202201,
    "reporting_group_id": "bc37cb31-08ce-4b22-8f4c-7d44692a4ef2",
    "asset_id": "89c100dc-0401-447f-a9f5-72ae124f3244"
  }
}

Response

Report

idstring uuid required
namestring required
company_idstring uuid required
status'locked' | 'unlocked' | 'archived' required
templated_report_namestring
inputobject

User input for a templated report based on the input schema for the desired templated report.

created_bystring uuid required
updated_bystring uuid required
s3_download_linkstring

Example response

{
  "input": {
    "year_month": 202201,
    "reporting_group_id": "bc37cb31-08ce-4b22-8f4c-7d44692a4ef2",
    "asset_id": "89c100dc-0401-447f-a9f5-72ae124f3244"
  }
}