Update Report Metadata

POST 
/api/v1/reports/:report_id

Update metadata for a report.

Request

Path Parameters

report_id uuidrequired

Query Parameters

project_id any
organization_id any

Cookie Parameters

session any

application/json

Body

required

name Name (string)required

The name of the report

Responses

200

Successful Response

application/json

Schema

Schema

id uuidrequired

The id of the report

name Name (string)required

The name of the report

report_metadata objectrequired

The metadata for the report

state ReportState (string)required

The state of the report

Possible values: [pending, planning, waiting_approval, generating, completed, error]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "report_metadata": {},
  "state": "pending"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}