Skip to content

Generate project policy report

POST
/api/v1/projects/{projectId}/policies/report
curl --request POST \
--url https://localhost:10001/api/v1/projects/1/policies/report \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "format": "example", "paper": "example", "policyCids": [ "example" ] }'

Fetches the policy manifest for the project and renders it to a report document via the pdfgen service

projectId
required
integer

Project ID

Policy report request

Media type application/json
object
format
string
paper
string
policyCids
Array<string>
Example generated
{
"format": "example",
"paper": "example",
"policyCids": [
"example"
]
}

Rendered policy report document

file

Bad request - Invalid project ID, request body, or missing policy CIDs

object
key
additional properties
string

Project not found

object
key
additional properties
string

Internal server error

object
key
additional properties
string

Bad gateway - pdfgen report generation failed

object
key
additional properties
string