Merge pull request #82 from Alfresco/dev-eromano-76

add getProcessDefinitionStartForm() input param processDefinitionId #76

Author: wabson

CHANGELOG.md

@@ -6,6 +6,20 @@ Alfresco JS API
 
 _This project provides a JavaScript client API into the v1 Alfresco REST API_
 
+<a name="0.3.8"></a>
+# [0.3.8](https://github.com/Alfresco/alfresco-js-api/releases/tag/0.3.8) (2016-xx-xx)
+
+## Fix
+- [Activiti API processApi.getProcessDefinitionStartForm() does not take a process def ID #76](https://github.com/Alfresco/alfresco-js-api/issues/76)
+
+```javascript
+
+var processDefinitionId = "pprocessDefinitionId_example"; // String | processDefinitionId
+
+this.alfrescoJsApi.activiti.processApi.getProcessDefinitionStartForm(processDefinitionId);
+```
+
+
 <a name="0.3.7"></a>
 # [0.3.7](https://github.com/Alfresco/alfresco-js-api/releases/tag/0.3.7) (2016-10-29)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "alfresco-js-api",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "JavaScript client library for the Alfresco REST API",
   "main": "main.js",
   "typings": "index.d.ts",

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

@@ -92,12 +92,16 @@ Retrieve the start form for a process definition
 ### Example
 ```javascript
 
-this.alfrescoJsApi.activiti.processApi.getProcessDefinitionStartForm();
+var processDefinitionId = "pprocessDefinitionId_example"; // String | processDefinitionId
+
+this.alfrescoJsApi.activiti.processApi.getProcessDefinitionStartForm(processDefinitionId);
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
-
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **processDefinitionId** | **String**| processDefinitionId | 
+ 
 ### Return type
 
 [**FormDefinitionRepresentation**](FormDefinitionRepresentation.md)

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

@@ -124,13 +124,21 @@
 
     /**
      * Retrieve the start form for a process definition
+     * @param {String} processDefinitionId processDefinitionId
      */
-    this.getProcessDefinitionStartForm = function() {
+    this.getProcessDefinitionStartForm = function(processDefinitionId) {
       var postBody = null;
 
+      // verify the required parameter 'processInstanceId' is set
+      if (processDefinitionId == undefined || processDefinitionId == null) {
+        throw "Missing the required parameter 'processDefinitionId' when calling getProcessInstanceContent";
+      }
+
 
       var pathParams = {
+        'processDefinitionId': processDefinitionId
       };
+
       var queryParams = {
       };
       var headerParams = {

test/activitProcessApi.spec.js

@@ -53,4 +53,14 @@ describe('Activiti Process Api', function () {
         });
     });
 
+    it('get process definition startForm', function (done) {
+        this.processMock.get200getProcessDefinitionStartForm();
+        var processDefinitionId = 'testProcess:1:7504';
+
+        this.alfrescoJsApi.activiti.processApi.getProcessDefinitionStartForm(processDefinitionId).then((data)=> {
+            expect(data.processDefinitionId).equal('testProcess:1:7504');
+            done();
+        });
+    });
+
 });

test/mockObjects/activiti/processMock.js

@@ -68,6 +68,79 @@ class ProcessMock extends BaseMock {
             });
     }
 
+    get200getProcessDefinitionStartForm() {
+        nock(this.host, {'encodedQueryParams': true})
+            .get('/activiti-app/api/enterprise/process-definitions/testProcess%3A1%3A7504/start-form')
+            .reply(200, {
+                'id': 2002,
+                'processDefinitionId': 'testProcess:1:7504',
+                'processDefinitionName': 'test process',
+                'processDefinitionKey': 'testProcess',
+                'tabs': [],
+                'fields': [{
+                    'fieldType': 'DynamicTableRepresentation',
+                    'id': 'label',
+                    'name': 'Label',
+                    'type': 'dynamic-table',
+                    'value': null,
+                    'required': false,
+                    'readOnly': false,
+                    'overrideId': false,
+                    'colspan': 1,
+                    'placeholder': null,
+                    'minLength': 0,
+                    'maxLength': 0,
+                    'minValue': null,
+                    'maxValue': null,
+                    'regexPattern': null,
+                    'optionType': null,
+                    'hasEmptyValue': null,
+                    'options': null,
+                    'restUrl': null,
+                    'restResponsePath': null,
+                    'restIdProperty': null,
+                    'restLabelProperty': null,
+                    'tab': null,
+                    'className': null,
+                    'params': {'existingColspan': 1, 'maxColspan': 1},
+                    'layout': {'row': -1, 'column': -1, 'colspan': 2},
+                    'sizeX': 2,
+                    'sizeY': 2,
+                    'row': -1,
+                    'col': -1,
+                    'visibilityCondition': null,
+                    'columnDefinitions': [{
+                        'id': 'user',
+                        'name': 'User',
+                        'type': 'Dropdown',
+                        'value': null,
+                        'optionType': 'rest',
+                        'options': [{'id': null, 'name': 'Option 1'}],
+                        'restResponsePath': null,
+                        'restUrl': 'https://jsonplaceholder.typicode.com/users',
+                        'restIdProperty': 'id',
+                        'restLabelProperty': 'name',
+                        'amountCurrency': null,
+                        'amountEnableFractions': false,
+                        'required': true,
+                        'editable': true,
+                        'sortable': true,
+                        'visible': true,
+                        'endpoint': null,
+                        'requestHeaders': null
+                    }]
+                }],
+                'outcomes': [],
+                'javascriptEvents': [],
+                'className': '',
+                'style': '',
+                'customFieldTemplates': {},
+                'metadata': {},
+                'variables': [],
+                'gridsterForm': false
+            });
+    }
+
 }
 
 module.exports = ProcessMock;