reporting module route (requires reporting:report:write)

POST

/v1/m/reporting/schedules

curl --request POST \
  --url https://example.com/v1/m/reporting/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cron": "example", "enabled": true, "format": "example", "framework": "example", "id": "example", "locale": "example", "report_type": "compliance-evidence", "team": "example" }'

• this engine

Creates one report schedule, and answers 501 when report scheduling is not wired.

Authorizations

• bearerAuth

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

cron

required

Must parse as the reporting module’s five-field cron expression.

string

enabled

Any of:

boolean

boolean

null

null

format

Any of:

string

Pdf is preserved; every other value, including empty, is normalized to html.

string

null

null

framework

Any of:

string

string

null

null

id

Any of:

string

string

null

null

locale

Any of:

string

string

null

null

report_type

required

string

Allowed values: compliance-evidence audit-summary finops-report access-review executive-summary

team

Any of:

string

string

null

null

key

additional properties

any

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}