Generate project policy report
POST
/api/v1/projects/{projectId}/policies/report
const
url
=
'
https://localhost:10001/api/v1/projects/1/policies/report
'
;
const
options
= {
method:
'
POST
'
,
headers: {Authorization:
'
'
,
'
Content-Type
'
:
'
application/json
'
},
body:
'
{"format":"example","paper":"example","policyCids":["example"]}
'
}
;
try
{
const
response
= await
fetch
(url
,
options);
const
data
= await
response
.
json
();
console
.
log
(data);
}
catch
(error) {
console
.
error
(error);
}
curl
--request
POST
\
--url
https://localhost:10001/api/v1/projects/1/policies/report
\
--header
'
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
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”
projectId
required
integer
Project ID
Request Body
Section titled “Request Body ”Policy report request
Media type
application/json
object
format
string
paper
string
policyCids
Array
Example generated
{
"format"
:
"
example
"
,
"paper"
:
"
example
"
,
"policyCids"
: [
"
example
"
]
}
Responses
Section titled “ Responses ”Rendered policy report document
file
file
Bad request - Invalid project ID, request body, or missing policy CIDs
object
key
additional properties
string
object
key
additional properties
string
Unauthorized - Authentication required
object
key
additional properties
string
object
key
additional properties
string
Forbidden - No project access or insufficient permissions
object
key
additional properties
string
object
key
additional properties
string
Project not found
object
key
additional properties
string
object
key
additional properties
string
Internal server error
object
key
additional properties
string
object
key
additional properties
string
Bad gateway - pdfgen report generation failed
object
key
additional properties
string
object
key
additional properties
string