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

Commit f5ee138

Browse files
authored
1.7.0 (#260)
* [ADF-622] Complete TypeScript definitions for JS-API (#236) * new definition for core * move to node 8 * change log update * update typescript 2.4.0 * [ADF-793] The ability to retrieve a rendition's url from the content API (#238) * add getRenditionUrl method * [ADF-793] getRenditionUrl * CHANGELOG update * Update CHANGELOG.md * updating declarations (#239) * fix constructor probpme d.ts * Fixing tslint error (#241) * index.d.ts fix tslint (#242) * update typings * Added isRelatedContent option to create related content on process in… (#243) * Added isRelatedContent option to create related content on process instance * Fix error on createRelated content - added change to changelog * Update CHANGELOG.md * APS ContentApi is not present on index.d.ts and SitesApi is not complete (#251) * fix upload index.d.ts * [ADF-1086] content api improvements (#254) * content api improvements * update type definitions * update changelog * Add audit task log endpoints (#255) -getTaskAuditJson -getTaskAuditPdf * [ADF-1200] Error handling for wrong host urls (#256) * login and ticket creation fixes * Update changelog * [ADF-1199] MinimalNodeEntryEntity is missing the "allowableOperations" property * 1.7.0
1 parent 928edd4 commit f5ee138

File tree

15 files changed

+574
-199
lines changed

15 files changed

+574
-199
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ target
1313
/package/
1414
/scripts/
1515
/dist/
16+
.history

CHANGELOG.md

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

55
# Alfresco JS API
6+
<a name="1.7.0"></a>
7+
# [1.7.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.7.0) (01-08-2017)
8+
## Fix
9+
- [Error handling for wrong host urls](https://github.com/Alfresco/alfresco-js-api/issues/257)
10+
- [APS ContentApi is not present on index.d.ts and SitesApi is not complete](https://github.com/Alfresco/alfresco-js-api/issues/249)
11+
- [MinimalNodeEntryEntity is missing the "allowableOperations" property](https://github.com/Alfresco/alfresco-js-api/issues/258)
12+
13+
## Features
14+
- [Audit Log API - The end points are missing](https://github.com/Alfresco/alfresco-js-api/issues/256)
15+
- [Allow providing "attachment" option value when generating content links](https://issues.alfresco.com/jira/browse/ADF-1086)
616

717
<a name="1.6.0"></a>
818
# [1.6.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.6.0) (29-06-2017)

index.d.ts

Lines changed: 135 additions & 111 deletions
Large diffs are not rendered by default.

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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.6.1",
3+
"version": "1.7.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/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,8 @@ Class | Method | HTTP request | Description
203203
*ActivitiPublicRestApi.TaskApi* | [**deleteTask**](docs/TaskApi.md#deleteTask) | **DELETE** /api/enterprise/tasks/{taskId} | Delete a Task
204204
*ActivitiPublicRestApi.TaskApi* | [**filterTasks**](docs/TaskApi.md#filterTasks) | **POST** /api/enterprise/tasks/filter | Filter list of Task
205205
*ActivitiPublicRestApi.TaskApi* | [**getChecklist**](docs/TaskApi.md#getChecklist) | **GET** /api/enterprise/tasks/{taskId}/checklist | Retrieve Checklist added to a task
206+
*ActivitiPublicRestApi.TaskApi* | [**getTaskAuditJson**](docs/TaskApi.md#getTaskAuditJson) | **GET** /api/enterprise/tasks/{taskId}/audit | Retrieve audit infromation in json format
207+
*ActivitiPublicRestApi.TaskApi* | [**getTaskAuditPdf**](docs/TaskApi.md#getTaskAuditPdf) | **GET** /app/rest/tasks/{taskId}/audit | Retrieve the task audit infromation in pdf format
206208
*ActivitiPublicRestApi.TaskApi* | [**getRelatedContentForTask**](docs/TaskApi.md#getRelatedContentForTask) | **GET** /api/enterprise/tasks/{taskId}/content | Retrieve which content is attached to a task
207209
*ActivitiPublicRestApi.TaskApi* | [**getRestFieldValuesColumn**](docs/TaskApi.md#getRestFieldValuesColumn) | **GET** /api/enterprise/task-forms/{taskId}/form-values/{field}/{column} | Retrieve Column Field Values
208210
*ActivitiPublicRestApi.TaskApi* | [**getRestFieldValues**](docs/TaskApi.md#getRestFieldValues) | **GET** /api/enterprise/task-forms/{taskId}/form-values/{field} | Retrieve Populated Field Values

src/alfresco-activiti-rest-api/docs/TaskApi.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Method | HTTP request | Description
1717
[**deleteTask**](TaskApi.md#deleteTask) | **DELETE** /api/enterprise/tasks/{taskId} | Delete a Task
1818
[**filterTasks**](TaskApi.md#filterTasks) | **POST** /api/enterprise/tasks/filter | Filter list of Task
1919
[**getChecklist**](TaskApi.md#getChecklist) | **GET** /api/enterprise/tasks/{taskId}/checklist | Retrieve Checklist added to a task
20+
[**getTaskAuditJson**](TaskApi.md#getTaskAuditJson) | **GET** /api/enterprise/tasks/{taskId}/audit | Retrieve audit infromation in json format
21+
[**getTaskAuditPdf**](TaskApi.md#getTaskAuditPdf) | **GET** /app/rest/tasks/{taskId}/audit | Retrieve the task audit infromation in pdf format
2022
[**getRelatedContentForTask**](TaskApi.md#getRelatedContentForTask) | **GET** /api/enterprise/tasks/{taskId}/content | Retrieve which content is attached to a task
2123
[**getRestFieldValuesColumn**](TaskApi.md#getRestFieldValuesColumn) | **GET** /api/enterprise/task-forms/{taskId}/form-values/{field}/{column} | Retrieve Column Field Values
2224
[**getRestFieldValues**](TaskApi.md#getRestFieldValues) | **GET** /api/enterprise/task-forms/{taskId}/form-values/{field} | Retrieve Populated Field Values
@@ -498,6 +500,40 @@ Name | Type | Description | Notes
498500

499501
No authorization required
500502

503+
### HTTP request headers
504+
505+
- **Content-Type**: application/json
506+
- **Accept**: application/json
507+
508+
<a name="getTaskAuditJson"></a>
509+
# **getTaskAuditJson**
510+
> TaskAuditRepresentation getTaskAuditJson(taskId)
511+
512+
Retrieve audit infromation in json format
513+
514+
### Example
515+
```javascript
516+
517+
var taskId = "taskId_example"; // String | taskId
518+
519+
520+
this.alfrescoJsApi.activiti.taskApi.getTaskAuditJson(taskId);
521+
```
522+
523+
### Parameters
524+
525+
Name | Type | Description | Notes
526+
------------- | ------------- | ------------- | -------------
527+
**taskId** | **String**| taskId |
528+
529+
### Return type
530+
531+
[**TaskAuditRepresentation**](TaskAuditRepresentation.md)
532+
533+
### Authorization
534+
535+
No authorization required
536+
501537
### HTTP request headers
502538

503539
- **Content-Type**: application/json
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# ActivitiPublicRestApi.TaskAuditRepresentation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**taskId** | **String** | | [optional]
7+
**taskName | **String** | | [optional]
8+
**processInstanceId** | **String** | | [optional]
9+
**processDefinitionName** | **String** | | [optional]
10+
**processDefinitionVersion** | **Integer** | | [optional]
11+
**assignee** | [**LightUserRepresentation**](LightUserRepresentation.md) | | [optional]
12+
**startTime** | **Date** | | [optional]
13+
**endTime** | **Date** | | [optional]
14+
**formData** | **Object** | | [optional]
15+
**selectedOutcome** | **String** | | [optional]
16+
**comments** | **Object** | | [optional]
17+
18+

src/alfresco-activiti-rest-api/src/api/TaskApi.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/TaskRepresentation', '../model/CommentRepresentation', '../model/ObjectNode', '../model/CompleteFormRepresentation', '../model/RelatedContentRepresentation', '../model/TaskFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormValueRepresentation', '../model/FormDefinitionRepresentation', '../model/ChecklistOrderRepresentation', '../model/SaveFormRepresentation', '../model/TaskUpdateRepresentation'], factory);
4+
define(['../../../alfrescoApiClient', '../model/TaskRepresentation', '../model/TaskAuditRepresentation', '../model/CommentRepresentation', '../model/ObjectNode', '../model/CompleteFormRepresentation', '../model/RelatedContentRepresentation', '../model/TaskFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormValueRepresentation', '../model/FormDefinitionRepresentation', '../model/ChecklistOrderRepresentation', '../model/SaveFormRepresentation', '../model/TaskUpdateRepresentation'], 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/TaskRepresentation'), require('../model/CommentRepresentation'), require('../model/ObjectNode'), require('../model/CompleteFormRepresentation'), require('../model/RelatedContentRepresentation'), require('../model/TaskFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormValueRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ChecklistOrderRepresentation'), require('../model/SaveFormRepresentation'), require('../model/TaskUpdateRepresentation'));
7+
module.exports = factory(require('../../../alfrescoApiClient'), require('../model/TaskRepresentation'), require('../model/TaskAuditRepresentation'), require('../model/CommentRepresentation'), require('../model/ObjectNode'), require('../model/CompleteFormRepresentation'), require('../model/RelatedContentRepresentation'), require('../model/TaskFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormValueRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ChecklistOrderRepresentation'), require('../model/SaveFormRepresentation'), require('../model/TaskUpdateRepresentation'));
88
} else {
99
// Browser globals (root is window)
1010
if (!root.ActivitiPublicRestApi) {
1111
root.ActivitiPublicRestApi = {};
1212
}
13-
root.ActivitiPublicRestApi.TaskApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.TaskRepresentation, root.ActivitiPublicRestApi.CommentRepresentation, root.ActivitiPublicRestApi.ObjectNode, root.ActivitiPublicRestApi.CompleteFormRepresentation, root.ActivitiPublicRestApi.RelatedContentRepresentation, root.ActivitiPublicRestApi.TaskFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ChecklistOrderRepresentation, root.ActivitiPublicRestApi.SaveFormRepresentation, root.ActivitiPublicRestApi.TaskUpdateRepresentation);
13+
root.ActivitiPublicRestApi.TaskApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.TaskRepresentation, root.ActivitiPublicRestApi.TaskAuditRepresentation, root.ActivitiPublicRestApi.CommentRepresentation, root.ActivitiPublicRestApi.ObjectNode, root.ActivitiPublicRestApi.CompleteFormRepresentation, root.ActivitiPublicRestApi.RelatedContentRepresentation, root.ActivitiPublicRestApi.TaskFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ChecklistOrderRepresentation, root.ActivitiPublicRestApi.SaveFormRepresentation, root.ActivitiPublicRestApi.TaskUpdateRepresentation);
1414
}
15-
}(this, function(ApiClient, TaskRepresentation, CommentRepresentation, ObjectNode, CompleteFormRepresentation, RelatedContentRepresentation, TaskFilterRequestRepresentation, ResultListDataRepresentation, FormValueRepresentation, FormDefinitionRepresentation, ChecklistOrderRepresentation, SaveFormRepresentation, TaskUpdateRepresentation) {
15+
}(this, function(ApiClient, TaskRepresentation, TaskAuditRepresentation, CommentRepresentation, ObjectNode, CompleteFormRepresentation, RelatedContentRepresentation, TaskFilterRequestRepresentation, ResultListDataRepresentation, FormValueRepresentation, FormDefinitionRepresentation, ChecklistOrderRepresentation, SaveFormRepresentation, TaskUpdateRepresentation) {
1616
'use strict';
1717

1818
/**
@@ -631,6 +631,76 @@
631631
);
632632
}
633633

634+
/**
635+
* Retrieve the task audit in the JSON format
636+
* @param {String} taskId taskId
637+
*/
638+
this.getTaskAuditJson = function(taskId) {
639+
var postBody = null;
640+
641+
// verify the required parameter 'taskId' is set
642+
if (taskId == undefined || taskId == null) {
643+
throw "Missing the required parameter 'taskId' when calling getTaskAuditPdf";
644+
}
645+
646+
var pathParams = {
647+
'taskId': taskId
648+
};
649+
var queryParams = {
650+
};
651+
var headerParams = {
652+
};
653+
var formParams = {
654+
};
655+
656+
var authNames = [];
657+
var contentTypes = ['application/json'];
658+
var accepts = ['application/json'];
659+
var returnType = TaskAuditRepresentation;
660+
661+
return this.apiClient.callApi(
662+
'/api/enterprise/tasks/{taskId}/audit', 'GET',
663+
pathParams, queryParams, headerParams, formParams, postBody,
664+
authNames, contentTypes, accepts, returnType
665+
);
666+
}
667+
668+
/**
669+
* Retrieve the task audit in the JSON format
670+
* @param {String} taskId taskId
671+
*/
672+
this.getTaskAuditPdf = function(taskId) {
673+
var postBody = null;
674+
675+
// verify the required parameter 'taskId' is set
676+
if (taskId == undefined || taskId == null) {
677+
throw "Missing the required parameter 'taskId' when calling getTaskAuditPdf";
678+
}
679+
680+
var pathParams = {
681+
'taskId': taskId
682+
};
683+
var queryParams = {
684+
};
685+
var headerParams = {
686+
};
687+
var formParams = {
688+
};
689+
690+
var authNames = [];
691+
var contentTypes = ['application/json'];
692+
var accepts = ['application/json'];
693+
var returnType = Object;
694+
var contextRoot = null;
695+
var responseType = 'blob';
696+
697+
return this.apiClient.callApi(
698+
'/app/rest/tasks/{taskId}/audit', 'GET',
699+
pathParams, queryParams, headerParams, formParams, postBody,
700+
authNames, contentTypes, accepts, returnType, contextRoot, responseType
701+
);
702+
}
703+
634704
/**
635705
* Function to receive the result of the getRelatedContentForTask operation.
636706
* @param {String} error Error message, if any.
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
(function(root, factory) {
2+
if (typeof define === 'function' && define.amd) {
3+
// AMD. Register as an anonymous module.
4+
define(['../../../alfrescoApiClient', '../model/LightUserRepresentation'], factory);
5+
} else if (typeof module === 'object' && module.exports) {
6+
// CommonJS-like environments that support module.exports, like Node.
7+
module.exports = factory(require('../../../alfrescoApiClient'), require('./LightUserRepresentation'));
8+
} else {
9+
// Browser globals (root is window)
10+
if (!root.ActivitiPublicRestApi) {
11+
root.ActivitiPublicRestApi = {};
12+
}
13+
root.ActivitiPublicRestApi.TaskAuditRepresentation = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.LightUserRepresentation);
14+
}
15+
}(this, function(ApiClient, LightUserRepresentation) {
16+
'use strict';
17+
18+
/**
19+
* The TaskAuditRepresentation model module.
20+
* @module model/TaskAuditRepresentation
21+
* @version 1.4.0
22+
*/
23+
24+
/**
25+
* Constructs a new <code>TaskAuditRepresentation</code>.
26+
* @alias module:model/TaskAuditRepresentation
27+
* @class
28+
*/
29+
var exports = function() {
30+
var _this = this;
31+
};
32+
33+
/**
34+
* Constructs a <code>TaskAuditRepresentation</code> from a plain JavaScript object, optionally creating a new instance.
35+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
36+
* @param {Object} data The plain JavaScript object bearing properties of interest.
37+
* @param {module:model/TaskAuditRepresentation} obj Optional instance to populate.
38+
* @return {module:model/TaskAuditRepresentation} The populated <code>TaskAuditRepresentation</code> instance.
39+
*/
40+
exports.constructFromObject = function(data, obj) {
41+
if (data) {
42+
obj = data || new exports();
43+
44+
if (data.hasOwnProperty('taskId')) {
45+
obj['taskId'] = ApiClient.convertToType(data['taskId'], 'String');
46+
}
47+
if (data.hasOwnProperty('taskName')) {
48+
obj['taskName'] = ApiClient.convertToType(data['taskName'], 'String');
49+
}
50+
if (data.hasOwnProperty('processInstanceId')) {
51+
obj['processInstanceId'] = ApiClient.convertToType(data['processInstanceId'], 'String');
52+
}
53+
if (data.hasOwnProperty('processDefinitionName')) {
54+
obj['processDefinitionName'] = ApiClient.convertToType(data['processDefinitionName'], 'String');
55+
}
56+
if (data.hasOwnProperty('processDefinitionVersion')) {
57+
obj['processDefinitionVersion'] = ApiClient.convertToType(data['processDefinitionVersion'], 'Integer');
58+
}
59+
if (data.hasOwnProperty('assignee')) {
60+
obj['assignee'] = LightUserRepresentation.constructFromObject(data['assignee']);
61+
}
62+
if (data.hasOwnProperty('startTime')) {
63+
obj['startTime'] = ApiClient.convertToType(data['startTime'], 'Date');
64+
}
65+
if (data.hasOwnProperty('endTime')) {
66+
obj['endTime'] = ApiClient.convertToType(data['endTime'], 'Date');
67+
}
68+
if (data.hasOwnProperty('formData')) {
69+
obj['formData'] = ApiClient.convertToType(data['formData'], [Object]);
70+
}
71+
if (data.hasOwnProperty('selectedOutcome')) {
72+
obj['selectedOutcome'] = ApiClient.convertToType(data['selectedOutcome'], 'String');
73+
}
74+
if (data.hasOwnProperty('comments')) {
75+
obj['comments'] = ApiClient.convertToType(data['comments'], [Object]);
76+
}
77+
}
78+
return obj;
79+
}
80+
81+
/**
82+
* @member {String} taskId
83+
*/
84+
exports.prototype['taskId'] = undefined;
85+
/**
86+
* @member {String} taskName
87+
*/
88+
exports.prototype['taskName'] = undefined;
89+
/**
90+
* @member {String} processDefinitionId
91+
*/
92+
exports.prototype['processDefinitionId'] = undefined;
93+
/**
94+
* @member {String} processDefinitionName
95+
*/
96+
exports.prototype['processDefinitionName'] = undefined;
97+
/**
98+
* @member {Integer} processDefinitionVersion
99+
*/
100+
exports.prototype['processDefinitionVersion'] = undefined;
101+
/**
102+
* @member {String} assignee
103+
*/
104+
exports.prototype['assignee'] = undefined;
105+
/**
106+
* @member {String} startTime
107+
*/
108+
exports.prototype['startTime'] = undefined;
109+
/**
110+
* @member {String} endTime
111+
*/
112+
exports.prototype['endTime'] = undefined;
113+
/**
114+
* @member {String} formData
115+
*/
116+
exports.prototype['formData'] = undefined;
117+
/**
118+
* @member {String} selectedOutcome
119+
*/
120+
exports.prototype['selectedOutcome'] = undefined;
121+
/**
122+
* @member {String} comments
123+
*/
124+
exports.prototype['comments'] = undefined;
125+
126+
return exports;
127+
}));
128+
129+

0 commit comments

Comments
 (0)