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

Commit 2e85b01

Browse files
eromanoeromano
authored
Merge pull request #268 from Alfresco/development
1.8.0
2 parents f5ee138 + b61ce4e commit 2e85b01

20 files changed

+1020
-12
lines changed

‎CHANGELOG.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,21 @@
33
</p>
44

55
# Alfresco JS API
6+
<a name="1.8.0"></a>
7+
8+
# [1.8.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.8.0) (05-09-2017)
9+
10+
## Features
11+
12+
- [Process Audit Log end points](https://github.com/Alfresco/alfresco-js-api/issues/263)
13+
- [Downloads API (requries 5.2.1 platform)](https://issues.alfresco.com/jira/browse/ADF-1225)
14+
- [getProfilePictures returns null](https://github.com/Alfresco/alfresco-js-api/issues/262)
15+
- [Adding a new method to retrieve the Profile Picture Url](https://github.com/Alfresco/alfresco-js-api/265)
16+
17+
## Fix
18+
19+
- [Favorites Api not passing the "include" settings to server](https://issues.alfresco.com/jira/browse/ADF-1394)
20+
621
<a name="1.7.0"></a>
722
# [1.7.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.7.0) (01-08-2017)
823
## Fix

‎index.d.ts‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,31 @@ declare namespace AlfrescoApi {
587587
getSharedLinkContent(sharedId?: string, opts?: any): Promise<{}>;
588588
}
589589

590+
export interface DownloadsApi {
591+
new(client: ApiClient): DownloadsApi;
592+
593+
createDownload(payload: DownloadBodyCreate, opts?: any): Promise<DownloadEntry>;
594+
getDownload(downloadId: string, opts?: any): Promise<DownloadEntry>;
595+
cancelDownload(downloadId: string): Promise<void>;
596+
}
597+
598+
export interface DownloadBodyCreate {
599+
nodeIds?: string[];
600+
}
601+
602+
export interface DownloadEntry {
603+
entry?: Download;
604+
}
605+
606+
export interface Download {
607+
filesAdded?: number;
608+
bytesAdded?: number;
609+
id: string;
610+
totalFiles: number;
611+
totalBytes: number;
612+
status: string;
613+
}
614+
590615
export interface TagsApi {
591616
new(client: ApiClient): TagsApi;
592617

@@ -1623,6 +1648,7 @@ declare namespace AlfrescoApi {
16231648
childAssociationsApi: ChildAssociationsApi;
16241649
commentsApi: CommentsApi;
16251650
customModelApi: CustomModelApi;
1651+
downloadsApi: DownloadsApi;
16261652
favoritesApi: FavoritesApi;
16271653
networksApi: NetworksApi;
16281654
nodesApi: NodesApi;

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "alfresco-js-api",
3-
"version": "1.7.0",
3+
"version": "1.8.0",
44
"description": "JavaScript client library for the Alfresco REST API",
55
"author": "Alfresco Software, Ltd.",
66
"main": "main.js",

‎src/alfresco-activiti-rest-api/docs/ProcessApi.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Method | HTTP request | Description
99
[**getProcessDefinitionStartForm**](ProcessApi.md#getProcessDefinitionStartForm) | **GET** /api/enterprise/process-definitions/{processDefinitionId}/start-form | Retrieve the start form for a process definition
1010
[**getProcessDefinitions**](ProcessApi.md#getProcessDefinitions) | **GET** /api/enterprise/process-definitions | Retrieve a list of process definitions
1111
[**getProcessInstanceContent**](ProcessApi.md#getProcessInstanceContent) | **GET** /api/enterprise/process-instances/{processInstanceId}/field-content | Retrieve content attached to process instance fields
12+
[**getProcessAuditJson**](ProcessApi.md#getProcessAuditJson) | **GET** /api/enterprise/process-instances/{processId}/audit-log | Retrieve process audit infromation in json format
13+
[**getProcessAuditPdf**](ProcessApi.md#getProcessAuditPdf) | **GET** /app/rest/process-instances/{processId}/audit | Retrieve the process audit infromation in pdf format
1214
[**getProcessInstanceStartForm**](ProcessApi.md#getProcessInstanceStartForm) | **GET** /api/enterprise/process-instances/{processInstanceId}/start-form | Get process start form
1315
[**getProcessInstance**](ProcessApi.md#getProcessInstance) | **GET** /api/enterprise/process-instances/{processInstanceId} | Retrieve a process instance information
1416
[**getProcessInstances**](ProcessApi.md#getProcessInstances) | **POST** /api/enterprise/process-instances/query | Retrieve a list of process instances
@@ -182,6 +184,73 @@ Name | Type | Description | Notes
182184

183185
No authorization required
184186

187+
### HTTP request headers
188+
189+
- **Content-Type**: application/json
190+
- **Accept**: application/json
191+
192+
<a name="getProcessAuditJson"></a>
193+
# **getProcessAuditJson**
194+
> ProcessInstanceAuditRepresentation getProcessAuditJson(processId)
195+
196+
Retrieve process audit infromation in json format
197+
198+
### Example
199+
```javascript
200+
201+
var processId = "processId_example"; // String | processId
202+
203+
204+
this.alfrescoJsApi.activiti.processApi.getProcessAuditJson(processId);
205+
```
206+
207+
### Parameters
208+
209+
Name | Type | Description | Notes
210+
------------- | ------------- | ------------- | -------------
211+
**processId** | **String**| processId |
212+
213+
### Return type
214+
215+
[**ProcessInstanceAuditRepresentation**](ProcessInstanceAuditRepresentation.md)
216+
217+
### Authorization
218+
219+
No authorization required
220+
221+
### HTTP request headers
222+
223+
- **Content-Type**: application/json
224+
- **Accept**: application/json
225+
226+
<a name="getProcessAuditPdf"></a>
227+
# **getProcessAuditPdf**
228+
> Blob getProcessAuditPdf(processId)
229+
230+
Retrieve process audit infromation in pdf format
231+
232+
### Example
233+
```javascript
234+
235+
var processId = "processId_example"; // String | processId
236+
237+
this.alfrescoJsApi.activiti.processApi.getProcessAuditPdf(processId);
238+
```
239+
240+
### Parameters
241+
242+
Name | Type | Description | Notes
243+
------------- | ------------- | ------------- | -------------
244+
**processId** | **String**| processId |
245+
246+
### Return type
247+
248+
[Blob]
249+
250+
### Authorization
251+
252+
No authorization required
253+
185254
### HTTP request headers
186255

187256
- **Content-Type**: application/json

‎src/alfresco-activiti-rest-api/docs/ProcessInstanceAuditRepresentation.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ActivitiPublicRestApi.ProcessInstanceAuditRepresentation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**processInstanceId** | **Integer** | | [optional]
7+
**processInstanceName | **String** | | [optional]
8+
**processDefinitionName** | **String** | | [optional]
9+
**processDefinitionVersion** | **Integer** | | [optional]
10+
**processInstanceStartTime** | **Date** | | [optional]
11+
**processInstanceEndTime** | **Date** | | [optional]
12+
**processInstanceInitiator** | **String** | | [optional]
13+
**entries** | **Object** | | [optional]
14+
**decisionInfo** | **Object** | | [optional]

‎src/alfresco-activiti-rest-api/docs/UserApi.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,39 @@ No authorization required
8383
- **Content-Type**: application/json
8484
- **Accept**: application/json
8585

86+
<a name="getProfilePictureUrl"></a>
87+
# **getProfilePictureUrl**
88+
> getProfilePictureUrl(userId)
89+
90+
Retrieve user profile picture
91+
92+
### Example
93+
```javascript
94+
95+
var userId = 789; // Integer | userId
96+
97+
this.alfrescoJsApi.activiti.userApi.getProfilePictureUrl(userId);
98+
```
99+
100+
### Parameters
101+
102+
Name | Type | Description | Notes
103+
------------- | ------------- | ------------- | -------------
104+
**userId** | **String**| userId |
105+
106+
### Return type
107+
108+
string
109+
110+
### Authorization
111+
112+
No authorization required
113+
114+
### HTTP request headers
115+
116+
- **Content-Type**: application/json
117+
- **Accept**: application/json
118+
86119
<a name="getUser"></a>
87120
# **getUser**
88121
> UserRepresentation getUser(userId)

‎src/alfresco-activiti-rest-api/src/api/ProcessApi.js‎

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
(function(root, factory) {
22
if (typeof define === 'function' && define.amd) {
33
// AMD. Register as an anonymous module.
4-
define(['../../../alfrescoApiClient', '../model/ProcessInstanceFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormDefinitionRepresentation', '../model/ProcessInstanceRepresentation', '../model/ProcessFilterRequestRepresentation', '../model/FormValueRepresentation', '../model/CreateProcessInstanceRepresentation'], factory);
4+
define(['../../../alfrescoApiClient', '../model/ProcessInstanceFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormDefinitionRepresentation', '../model/ProcessInstanceRepresentation', '../model/ProcessInstanceAuditRepresentation', '../model/ProcessFilterRequestRepresentation', '../model/FormValueRepresentation', '../model/CreateProcessInstanceRepresentation'], factory);
55
} else if (typeof module === 'object' && module.exports) {
66
// CommonJS-like environments that support module.exports, like Node.
7-
module.exports = factory(require('../../../alfrescoApiClient'), require('../model/ProcessInstanceFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ProcessInstanceRepresentation'), require('../model/ProcessFilterRequestRepresentation'), require('../model/FormValueRepresentation'), require('../model/CreateProcessInstanceRepresentation'));
7+
module.exports = factory(require('../../../alfrescoApiClient'), require('../model/ProcessInstanceFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ProcessInstanceRepresentation'), require('../model/ProcessInstanceAuditRepresentation'), require('../model/ProcessFilterRequestRepresentation'), require('../model/FormValueRepresentation'), require('../model/CreateProcessInstanceRepresentation'));
88
} else {
99
// Browser globals (root is window)
1010
if (!root.ActivitiPublicRestApi) {
1111
root.ActivitiPublicRestApi = {};
1212
}
13-
root.ActivitiPublicRestApi.ProcessApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.ProcessInstanceFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ProcessInstanceRepresentation, root.ActivitiPublicRestApi.ProcessFilterRequestRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.CreateProcessInstanceRepresentation);
13+
root.ActivitiPublicRestApi.ProcessApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.ProcessInstanceFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ProcessInstanceRepresentation, root.ActivitiPublicRestApi.ProcessInstanceAuditRepresentation, root.ActivitiPublicRestApi.ProcessFilterRequestRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.CreateProcessInstanceRepresentation);
1414
}
15-
}(this, function(ApiClient, ProcessInstanceFilterRequestRepresentation, ResultListDataRepresentation, FormDefinitionRepresentation, ProcessInstanceRepresentation, ProcessFilterRequestRepresentation, FormValueRepresentation, CreateProcessInstanceRepresentation) {
15+
}(this, function(ApiClient, ProcessInstanceFilterRequestRepresentation, ResultListDataRepresentation, FormDefinitionRepresentation, ProcessInstanceRepresentation, ProcessInstanceAuditRepresentation, ProcessFilterRequestRepresentation, FormValueRepresentation, CreateProcessInstanceRepresentation) {
1616
'use strict';
1717

1818
/**
@@ -368,6 +368,76 @@
368368
);
369369
}
370370

371+
/**
372+
* Retrieve the process audit in the JSON format
373+
* @param {String} processId processId
374+
*/
375+
this.getProcessAuditJson = function(processId) {
376+
var postBody = null;
377+
378+
// verify the required parameter 'processId' is set
379+
if (processId == undefined || processId == null) {
380+
throw "Missing the required parameter 'processId' when calling getProcessAuditJson";
381+
}
382+
383+
var pathParams = {
384+
'processId': processId
385+
};
386+
var queryParams = {
387+
};
388+
var headerParams = {
389+
};
390+
var formParams = {
391+
};
392+
393+
var authNames = [];
394+
var contentTypes = ['application/json'];
395+
var accepts = ['application/json'];
396+
var returnType = ProcessInstanceAuditRepresentation;
397+
398+
return this.apiClient.callApi(
399+
'/api/enterprise/process-instances/{processId}/audit-log', 'GET',
400+
pathParams, queryParams, headerParams, formParams, postBody,
401+
authNames, contentTypes, accepts, returnType
402+
);
403+
}
404+
405+
/**
406+
* Retrieve the process audit in the JSON format
407+
* @param {String} processId processId
408+
*/
409+
this.getProcessAuditPdf = function(processId) {
410+
var postBody = null;
411+
412+
// verify the required parameter 'processId' is set
413+
if (processId == undefined || processId == null) {
414+
throw "Missing the required parameter 'processId' when calling getProcessAuditPdf";
415+
}
416+
417+
var pathParams = {
418+
'processId': processId
419+
};
420+
var queryParams = {
421+
};
422+
var headerParams = {
423+
};
424+
var formParams = {
425+
};
426+
427+
var authNames = [];
428+
var contentTypes = ['application/json'];
429+
var accepts = ['application/json'];
430+
var returnType = Object;
431+
var contextRoot = null;
432+
var responseType = 'blob';
433+
434+
return this.apiClient.callApi(
435+
'/app/rest/process-instances/{processId}/audit', 'GET',
436+
pathParams, queryParams, headerParams, formParams, postBody,
437+
authNames, contentTypes, accepts, returnType, contextRoot, responseType
438+
);
439+
}
440+
371441
/**
372442
* Function to receive the result of the getRestFieldValues operation.
373443
* @param {String} error Error message, if any.

‎src/alfresco-activiti-rest-api/src/api/UserApi.js‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,21 @@
114114
var authNames = [];
115115
var contentTypes = ['application/json'];
116116
var accepts = ['application/json'];
117-
var returnType = null;
117+
var returnType = Object;
118+
var contextRoot = null;
119+
var responseType = 'blob';
118120

119121
return this.apiClient.callApi(
120122
'/api/enterprise/users/{userId}/picture', 'GET',
121123
pathParams, queryParams, headerParams, formParams, postBody,
122-
authNames, contentTypes, accepts, returnType
124+
authNames, contentTypes, accepts, returnType, contextRoot, responseType
123125
);
124126
}
125127

128+
this.getUserProfilePictureUrl = function(userId) {
129+
return this.apiClient.basePath + '/app/rest/users/'+userId+'/picture';
130+
}
131+
126132
/**
127133
* Function to receive the result of the getUser operation.
128134
* @param {String} error Error message, if any.

0 commit comments

Comments
 (0)