UNPKG

alfresco-js-api

Version:

JavaScript client library for the Alfresco REST API

github.com/Alfresco/alfresco-js-api

Alfresco/alfresco-js-api

112 lines (73 loc) • 3.48 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# ActivitiPublicRestApi.ProcessDefinitionsFormApi All URIs are relative to *https://localhost:8080/activiti-app* Method | HTTP request | Description ------------- | ------------- | ------------- [**getProcessDefinitionStartForm**](ProcessDefinitionsFormApi.md#getProcessDefinitionStartForm) | **GET** /api/enterprise/process-definitions/{processDefinitionId}/start-form | Retrieve the start form for a process definition [**getRestFieldValues**](ProcessDefinitionsFormApi.md#getRestFieldValues) | **GET** /api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field} | Retrieve field values (eg. the typeahead field) [**getRestTableFieldValues**](ProcessDefinitionsFormApi.md#getRestTableFieldValues) | **GET** /api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}/{column} | Retrieve field values (eg. the table field) <a name="getProcessDefinitionStartForm"></a> # **getProcessDefinitionStartForm** > FormDefinitionRepresentation getProcessDefinitionStartForm() Retrieve the start form for a process definition ### Example ```javascript var processDefinitionId = "processDefinitionId"; // String | processDefinitionId this.alfrescoJsApi.activiti.processDefinitionsFormApi.getProcessDefinitionStartForm(processDefinitionId); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **processDefinitionId** | **String**| processDefinitionId | ### Return type [**FormDefinitionRepresentation**](FormDefinitionRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="getRestFieldValues"></a> # **getRestFieldValues** > [FormValueRepresentation] getRestFieldValues() Retrieve field values (eg. the typeahead field) ### Example ```javascript var processDefinitionId = "processDefinitionId"; // String | processDefinitionId var field = "field"; // String | field this.alfrescoJsApi.activiti.processDefinitionsFormApi.getRestFieldValues(processDefinitionId, field); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **processDefinitionId** | **String**| processDefinitionId | **field** | **String**| field | ### Return type [**[FormValueRepresentation]**](FormValueRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="getRestTableFieldValues"></a> # **getRestTableFieldValues** > [FormValueRepresentation] getRestTableFieldValues() Retrieve field values (eg. the table field) ### Example ```javascript var processDefinitionId = "processDefinitionId"; // String | processDefinitionId var field = "field"; // String | field var column = "column"; // String | column this.alfrescoJsApi.activiti.processDefinitionsFormApi.getRestTableFieldValues(processDefinitionId, field, column); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **processDefinitionId** | **String**| processDefinitionId | **field** | **String**| field | **column** | **String**| column | ### Return type [**[FormValueRepresentation]**](FormValueRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json