Skip to content

Latest commit

 

History

History
executable file
·
360 lines (235 loc) · 8.48 KB

ReportApi.md

File metadata and controls

executable file
·
360 lines (235 loc) · 8.48 KB
Raw

ActivitiPublicRestApi.ReportApi

All URIs are relative to https://localhost:8080/activiti-app

Method HTTP request Description
createDefaultReports POST /app/rest/reporting/default-reports Create the default reports
getReportList GET /app/rest/reporting/reports Retrieve the available report list.
getReportParams GET /app/rest/reporting/report-params/{reportId} Retrieve the parameters referring to the reportId.
getProcessDefinitions GET /app/rest/reporting/process-definitions Retrieve the process definition list for all the apps.
getTasksByProcessDefinitionId GET /app/rest/reporting/report-params/{reportId}/tasks Retrieves all tasks that refer to the processDefinitionId
getReportsByParams GET /app/rest/reporting/report-params/{reportId} Generate the reports
updateReport PUT /app/rest/reporting/reports/{reportId} Update the report
exportToCsv POST /app/rest/reporting/reports/{reportId}/export-to-csv Export a report as csv
saveReport POST /app/rest/reporting/reports/{reportId} Save the report
deleteReport DELETE /app/rest/reporting/reports/{reportId} Delete a report

createDefaultReports

createDefaultReports()

Create the default reports

Example

this.alfrescoJsApi.activiti.reportApi.createDefaultReports();

Parameters

No parameters required.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReportList

[ReportParametersDefinition] getReportList()

Retrieve the available report list.

Example

this.alfrescoJsApi.activiti.reportApi.getReportList();

Parameters

No parameters required.

Return type

[ReportParametersDefinition]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReportParams

ReportParametersDefinition getReportParams(reportId)

Retrieve the parameters referring to the reportId.

Example

var reportId = "1"; // String | reportId

this.alfrescoJsApi.activiti.reportApi.getReportParams(reportId);

Parameters

Name Type Description Notes
reportId String reportId

Return type

ReportParametersDefinition

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProcessDefinitions

ParameterValueRepresentation getProcessDefinitions()

Retrieve the process definition list for all the apps.

Example

this.alfrescoJsApi.activiti.reportApi.getProcessDefinitions();

Parameters

No parameters required.

Return type

ParameterValueRepresentation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getTasksByProcessDefinitionId

['String'] getTasksByProcessDefinitionId(reportId, processDefinitionId)

Retrieves all tasks that refer to the processDefinitionId

Example

var reportId = "1"; // String | reportId
var processDefinitionId = "1"; // String | processDefinitionId

this.alfrescoJsApi.activiti.reportApi.getTasksByProcessDefinitionId(reportId, processDefinitionId);

Parameters

Name Type Description Notes
reportId String reportId
processDefinitionId String process definition id

Return type

['String']

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReportsByParams

ReportCharts getReportsByParams(reportId, paramsQuery)

Generate the reports based on the input parameters

Example

var reportId = "1"; // String | reportId
var paramsQuery = {status: 'ALL'}; // Object | paramsQuery

this.alfrescoJsApi.activiti.reportApi.getReportsByParams(reportId, paramsQuery);

Parameters

Name Type Description Notes
reportId String reportId
paramsQuery Object Query parameters

Return type

ReportCharts

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateReport

updateReport(reportId, name)

Update the report details

Example

var reportId = "1"; // String | reportId
var name = "new Fake name"; // String | name

this.alfrescoJsApi.activiti.reportApi.updateReport(reportId, name);

Parameters

Name Type Description Notes
reportId String reportId
name String The report name

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

exportToCsv

exportToCsv(reportId, queryParms)

Export a report as csv

Example

var reportId = "1"; // String | reportId
var queryParms = {
            'processDefinitionId': 'TEST:99:999',
            'dateRange': {
                'startDate': '2017-01-01T00:00:00.000Z',
                'endDate': '2017-01-24T23:59:59.999Z',
                'rangeId': 'currentYear'
            },
            'slowProcessInstanceInteger': 10,
            'status': 'All',
            '__reportName': 'FAKE_REPORT_NAME'
        };

this.alfrescoJsApi.activiti.reportApi.exportToCsv(reportId, queryParms);

Parameters

Name Type Description Notes
reportId String reportId
queryParms Object Query parameters

Return type

['String']

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

saveReport

saveReport(reportId, queryParams)

Save a report

Example

var reportId = "1"; // String | reportId
var queryParms = {
            'processDefinitionId': 'TEST:99:999',
            'dateRange': {
                'startDate': '2017-01-01T00:00:00.000Z',
                'endDate': '2017-01-24T23:59:59.999Z',
                'rangeId': 'currentYear'
            },
            'slowProcessInstanceInteger': 10,
            'status': 'All',
            '__reportName': 'FAKE_REPORT_NAME'
        };

this.alfrescoJsApi.activiti.reportApi.saveReport(reportId, queryParms);

Parameters

Name Type Description Notes
reportId String reportId
queryParms Object Query parameters

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteReport

deleteReport(reportId)

Delete a report

Example

var reportId = "1"; // String | reportId

this.alfrescoJsApi.activiti.reportApi.deleteReport(reportId);

Parameters

Name Type Description Notes
reportId String reportId

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json