Gera um relatório da organização informando o ID do relatório na URL.
URL
{RMUrl}/api/organization/reports/<ReportId>/generate
MÉTODO DE SOLICITAÇÃO
POST
PARÂMETROS DA URL
ReportId: este parâmetro é informado na URL e não precisa ser enviado através do POST.
CONTEÚDO DO FORMULÁRIO
ReportFormat (obrigatório): formato em que o relatório será gerado. Valores aceitos: "Pdf" e "Rtf".
GenerateWhenEmpty (opcional): define se o relatório será gerado mesmo com o escopo vazio. Valores aceitos: "true" e "false".
FilterRiskQuestionnaireAnswerByRiskProject (opcional): filtro para os projetos de risco a serem incluídos no relatório de riscos. Os códigos dos projetos devem ser informados aqui. Observe que esse filtro só pode ser utilizado em relatórios de riscos (ror, rorthreat, rer e rar).
FilterRiskQuestionnaireAnswerByAsset (opcional): filtro para os ativos a serem incluídos no relatório de riscos. Os Ids dos ativos devem ser informados aqui. Observe que esse filtro só pode ser utilizado em relatórios de riscos (ror, rorthreat, rer e rar).
Consultas SQL podem ser incluídas como fontes de dados nos relatórios. Essas consultas podem ser filtradas por um conjunto de campos no conteúdo do formulário.
QueryName (opcional): nome da consulta SQL.
FieldName (opcional): nome do campo na consulta SQL.
Operator (opcional): operador no filtro aplicado ao campo da consulta SQL. Os seguintes operadores são suportados:
•Campo do tipo Texto: Equal, NotEqual, Contains, NotContains, IsEmpty, IsNotEmpty, StartWith e EndWith;
•Campo do tipo Número: Equal, NotEqual GreaterThan, LessThan, GreaterOrEqualThan, LessOrEqualThan, IsEmpty e IsNotEmpty;
•Campo do tipo Data: Equal, NotEqual GreaterThan, LessThan, GreaterOrEqualThan; LessOrEqualThan, IsEmpty, IsNotEmpty e IsToday;
•Campo tipo Guid: Equal, NotEqual, IsEmpty e IsNotEmpty.
Value (opcional): valor do filtro.
EXEMPLO DO CONTEÚDO DO FORMULÁRIO
Gerar um relatório utilizando o ID:
{
"ReportFormat":"PDF",
"GenerateWhenEmpty": true,
"FilterRiskQuestionnaireAnswerByRiskProject": [ "PRJR19003", "PRJR19002"],
"FilterRiskQuestionnaireAnswerByAsset": ["5e2a3967-27d1-480f-8488-eaaedc8b08f4", "71f41137-83ae-462e-ac7b-a4236a298ed0"],
"SQLFilters": [
{ "QueryName": "Consulta Minuta Elaborar",
"Filters": [{ "FieldName": "ano_paint",
"Operator": "Equal",
"Value": "2021"}
]
}
]
}
RESPOSTA DE SUCESSO
O relatório é gerado e o seu conteúdo é retornado no formato Base64 no campo Report conforme o exemplo abaixo:
{
"Error": "None",
"Orientation": "Default",
"ReportName": "Sample Report",
"Culture": "en-us",
"Format": "Pdf"
"Report":"JVBERi0xLjQNCjEgMCBvYmoNCjw8IA...KL0E2IDk1DQolJUVPRg==",
}