generateProjectReport
Generates a report for a project
generateProjectReport(
projectId: ID!
language: String = "enUs"
vulnerabilityCriticity: [SeverityCategory!]
vulnerabilityStatuses: [IssueStatusLabel!]
requirements: Boolean = false
evidences: Boolean = false
reportType: ProjectReportTypeEnum!
attackGraph: Boolean = false
): Boolean!
Arguments
generateProjectReport.projectId ● ID! non-null scalar
generateProjectReport.language ● String scalar
generateProjectReport.vulnerabilityCriticity ● [SeverityCategory!] list enum
generateProjectReport.vulnerabilityStatuses ● [IssueStatusLabel!] list enum
generateProjectReport.requirements ● Boolean scalar
generateProjectReport.evidences ● Boolean scalar
generateProjectReport.reportType ● ProjectReportTypeEnum! non-null enum
generateProjectReport.attackGraph ● Boolean scalar
Type
Boolean scalar
The Boolean scalar type represents true or false.
Example request
This generated query uses placeholders for required values. Replace them with values available to your API key before running it.
Before you run it
Run the projects query first and use data.projects.collection[].id as projectId.
- cURL
- JavaScript
- Python
curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetGenerateProjectReport($projectId: ID!, $reportType: ProjectReportTypeEnum!) {\n generateProjectReport(projectId: $projectId, reportType: $reportType)\n}","variables":{"projectId":"<project_id>","reportType":"TECHNICAL"}}'
const response = await fetch('https://api.convisoappsec.com/graphql', {
method: 'POST',
headers: {
'content-type': 'application/json',
'x-api-key': process.env.CONVISO_API_KEY,
},
body: JSON.stringify({
query: "query GetGenerateProjectReport($projectId: ID!, $reportType: ProjectReportTypeEnum!) {\n generateProjectReport(projectId: $projectId, reportType: $reportType)\n}",
variables: {
"projectId": "<project_id>",
"reportType": "TECHNICAL"
},
}),
});
const { data, errors } = await response.json();
if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);
import json
import os
import requests
response = requests.post(
'https://api.convisoappsec.com/graphql',
headers={
'content-type': 'application/json',
'x-api-key': os.environ['CONVISO_API_KEY'],
},
json={
'query': "query GetGenerateProjectReport($projectId: ID!, $reportType: ProjectReportTypeEnum!) {\n generateProjectReport(projectId: $projectId, reportType: $reportType)\n}",
'variables': json.loads("{\"projectId\":\"<project_id>\",\"reportType\":\"TECHNICAL\"}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Contribute to the Docs
Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.
How to contribute