Skip to content
This repository was archived by the owner on Jun 11, 2025. It is now read-only.

Commit 65255ce

Browse files
VitoAlbanomauriziovitale
authored andcommitted
#164 - fix readme for new api methods and added minify version (#168)
1 parent 25ae1f0 commit 65255ce

File tree

3 files changed

+510
-493
lines changed

3 files changed

+510
-493
lines changed

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ This project provides a JavaScript client API into the Alfresco REST API and Act
7979
* [Tasks of process definition](#tasks-of-process-definition)
8080
* [Generate reports](#generate-reports)
8181
* [Update report details](#update-report-details)
82+
* [Export to csv](#export-to-csv)
83+
* [Save Report](#save-report)
84+
* [Delete report](#delete-report)
8285
- [Development](#development)
8386
- [Release History](#release-history)
8487

@@ -88,7 +91,7 @@ This project provides a JavaScript client API into the Alfresco REST API and Act
8891

8992
# Prerequisites
9093

91-
To correctly use the alafresco js api the minimal supported version are:
94+
To correctly use the alfresco js api the minimal supported version are:
9295

9396
- 5.2.a-EA Alfresco Platform Repository (version [5.2.a-EA](https://wiki.alfresco.com/wiki/Community_file_list_201606-EA) or newer)
9497
- 1.5 Activiti
@@ -1060,19 +1063,18 @@ var name = "new Fake name"; // String | reportId
10601063
this.alfrescoJsApi.activiti.reportApi.updateReport(reportId, name);
10611064
```
10621065

1063-
# **export to csv**
1064-
> exportToCsv(reportId, queryParms)
1066+
## Export to csv
1067+
exportToCsv(reportId, queryParms)
10651068

1066-
Export a report as csv
1067-
1068-
### Parameters
1069+
> Export a report as csv
10691070
1071+
####Parameters
10701072
Name | Type | Description | Notes
10711073
------------- | ------------- | ------------- | -------------
10721074
**reportId** | **String**| reportId |
10731075
**queryParms** | **Object**| Query parameters |
10741076

1075-
### Example
1077+
####Example
10761078
```javascript
10771079

10781080
var reportId = "1"; // String | reportId
@@ -1091,19 +1093,19 @@ var queryParms = {
10911093
this.alfrescoJsApi.activiti.reportApi.exportToCsv(reportId, queryParms);
10921094
```
10931095

1094-
# **save report**
1095-
> saveReport(reportId, queryParams)
1096+
## Save Report
10961097

1097-
Save a report
1098+
saveReport(reportId, queryParams)
10981099

1099-
### Parameters
1100+
> Save a report
11001101
1102+
####Parameters
11011103
Name | Type | Description | Notes
11021104
------------- | ------------- | ------------- | -------------
11031105
**reportId** | **String**| reportId |
11041106
**queryParms** | **Object**| Query parameters |
11051107

1106-
### Example
1108+
####Example
11071109
```javascript
11081110

11091111
var reportId = "1"; // String | reportId
@@ -1122,18 +1124,17 @@ var queryParms = {
11221124
this.alfrescoJsApi.activiti.reportApi.saveReport(reportId, queryParms);
11231125
```
11241126

1125-
# **delete report**
1126-
> deleteReport(reportId)
1127-
1128-
Delete a report
1127+
## Delete report
1128+
deleteReport(reportId)
11291129

1130-
### Parameters
1130+
> Delete a report
11311131
1132+
####Parameters
11321133
Name | Type | Description | Notes
11331134
------------- | ------------- | ------------- | -------------
11341135
**reportId** | **String**| reportId |
11351136

1136-
### Example
1137+
####Example
11371138
```javascript
11381139

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

0 commit comments

Comments
 (0)