Module: reporting

Copyright 2020 Parsable, Inc
API address: /api/reports
APIs for reporting on Jobs.

ModuleServicesData typesConstants
reportingReportingService
ReportOptions
ReportType

Enumerations

Enumeration: ReportType


JOB1
JOB_AUDIT2
ISSUE3

Data structures

Struct: ReportOptions

KeyFieldTypeDescriptionRequirednessDefault value
1typeReportTypeoptionalReportType.JOB


Services

Service: ReportingService

Function: ReportingService.generateJobReport

void generateJobReport(string jobId,
                       map<string, string> params)
    throws common.SystemException
Sends an email with the job report attached as pdf Params: these are liable to change, and are defined in gutenberg. Check here https://github.com/parsable/gutenberg/blob/master/src/components/JobDetailReport/ReportParams.md Note : Only send up true, do not send up false. The value checks for existence of paramater not the parameter value it self.

Function: ReportingService.generateJobReportForEmails

void generateJobReportForEmails(string jobId,
                                map<string, string> params,
                                list<string> emails)
    throws common.SystemException
Sends multiple emails with job report attached as pdf. list emails specifies the list of email addresses that should receive the job report pdf.

Function: ReportingService.generateJobReportForEmailsV2

void generateJobReportForEmailsV2(string jobId,
                                  map<string, string> params,
                                  list<string> emails,
                                  ReportOptions opts)
    throws common.SystemException
Sends multiple emails with job, audit or issue report attached as pdf. param emails: specifies the list of email addresses that should receive the job report pdf. If left blank, the email will be only sent to the authenticated user.