UNPKG

alfresco-js-api

Version:

JavaScript client library for the Alfresco REST API

github.com/Alfresco/alfresco-js-api

Alfresco/alfresco-js-api

117 lines (71 loc) • 3.06 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
113
114
115
116
117
# ActivitiPublicRestApi.TaskCheckListApi All URIs are relative to *https://localhost:8080/activiti-app* Method | HTTP request | Description ------------- | ------------- | ------------- [**addSubtask**](TaskCheckListApi.md#addSubtask) | **POST** /api/enterprise/tasks/{taskId}/checklist | Create a task checklist [**getChecklist**](TaskCheckListApi.md#getChecklist) | **GET** /api/enterprise/tasks/{taskId}/checklist | Retrieve Checklist added to a task [**orderChecklist**](TaskCheckListApi.md#orderChecklist) | **PUT** /api/enterprise/tasks/{taskId}/checklist | Change the order of items on a checklist <a name="addSubtask"></a> # **addSubtask** > TaskRepresentation addSubtask(taskId, taskRepresentation) Create a task checklist ### Example ```javascript var taskId = "taskId_example"; // String | taskId var taskRepresentation = new this.alfrescoJsApi.activiti.TaskRepresentation(); // TaskRepresentation | taskRepresentation this.alfrescoJsApi.activiti.taskCheckListApi.addSubtask(taskId, taskRepresentation); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **taskId** | **String**| taskId | **taskRepresentation** | [**TaskRepresentation**](TaskRepresentation.md)| taskRepresentation | ### Return type [**TaskRepresentation**](TaskRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="getChecklist"></a> # **getChecklist** > ResultListDataRepresentation getChecklist(taskId) Retrieve Checklist added to a task ### Example ```javascript var taskId = "taskId_example"; // String | taskId this.alfrescoJsApi.activiti.taskCheckListApi.getChecklist(taskId); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **taskId** | **String**| taskId | ### Return type [**ResultListDataRepresentation**](ResultListDataRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="orderChecklist"></a> # **orderChecklist** > orderChecklist(taskId, orderRepresentation) Change the order of items on a checklist ### Example ```javascript var taskId = "taskId_example"; // String | taskId var orderRepresentation = new this.alfrescoJsApi.activiti.ChecklistOrderRepresentation(); // ChecklistOrderRepresentation | orderRepresentation this.alfrescoJsApi.activiti.taskCheckListApi.orderChecklist(taskId, orderRepresentation); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **taskId** | **String**| taskId | **orderRepresentation** | [**ChecklistOrderRepresentation**](ChecklistOrderRepresentation.md)| orderRepresentation | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json